yes, i think we all know how you feel about POD. ;-)

i've thought of something like POD on steroids. pod2html is a nice start for web-enabling the whole thing, and some kind of (ack!) custom parser could generate the meta-data to shove info into a database and "make it searchable" (so could something like htdig, but i worry about false positive and things like that just from a full-text search ).

i like POD, but POD does have its limitations. one of the main limitiations being that any 'cross-references' (like function Foo::bar called by package Bar::baz ) has to be done by hand. for an undocumented application that's sliced way too thin ... that's going to be a nightmare.

( the app author seriously has modules like:
Application::Mailer::Mailer::SendMail
which does NOTHING but accept a stringified MIME::Lite message ( from  $obj->as_string() ), open a SENDMAIL pipe, and print to that pipe. i don't know about everyone else, but that's a bit too sliced for my taste.

In reply to Re^2: documentation generator? web-enabled perldoc? by geektron
in thread documentation generator? web-enabled perldoc? by geektron

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.