I have to agree with some of the other responses - Perl's POD is a good first step, but it's inadequate for larger projects. I've recently worked on a project that involved C++, and we decided to try Doxygen for our API documentation. I have to say, I am very impressed with it - it can generated interlinked HTML documentation (ala Javadoc), tex output (with the ability to produce a PDF manual), and manpages. It has facilities for documenting at the class level, member level, as well as parameters and return values from methods. It generates class hierarchies.

It is my opinion that Perl would be well served by adopting a documentation tool/format with a similar level of features. The links really help developers get familliar with the project quickly, the generated hierarchy diargrams and collobration diagrams really aid in understanding object hierarchies.

There has been some talk about this for Perl6

Kyle

In reply to Re: Why I'm a Pod::Nazi by mortis
in thread Why I'm a Pod::Nazi by Bobcat

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.