i've been tasked with creating a documentation base for our (currently *undocumented* -- not even good comments or self-documenting code ) primary application. an easy thing to do (once i have a full handle on the code in all its intricacies and weaving around and ... ) and a good way to really know the guts of the application.

thing is, the PHB wants to have a 'searchable, web-enabled' documentation repository ( think something *like* cvsweb or doxygen )

for those that haven't seen doxygen, i found it when reading through the drupal CMS site. it's some form of documentation generator (at the very least, it generates HTML docs like javadoc).

i don't remember seeing anything like, say, doxygen or javadoc for perl. if there's such a thing out there, i'd love to use it and not re-invent a wheel. even for the 'learning experiene' on this one -- documenting the code should be my primary concern, not reinventing an HTML page generation app.

if there *isn't* something like these out there, i do think i'll see about getting on the doxygen team to make the doodad work with perl.

so, do the rest of you think there's an equivalent out there? or am i gonna jump into an open-source programming team?

In reply to 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.