Hi

One cheesy thing that you could do is to use Doxygen by putting all the Doxygen comments after an __END__.

#-- Perl script

print "Test Perl Script\n";

__END__

/*! \class Test
     \brief A test class.

     A more detailed class description.
 */

[download]

You'd have to use the "Documentation at other places" format and you'd wouldn't get any of the source scanning features.

The other problem is that the .pl extension isn't recognized. You'd either have to work on the Doxygen source, or write a wrapper script that linked your .pm files to a recognized extension. This hack creates problems in the doc itself, because it says things like 

  was generated from the following file:

    * test2.cpp

[download]
instead of 
   * test2.pm

[download]

Also, based on some of the other posts, it appears there is a Perl-to-Doxygen script call DoxyFilt. However, I couldn't connect to that site. It appears to read the POD and parse the module to create pseudo-C files with the Doxygen comments.

- jim

In reply to Re: Documentation system by jimbojones
in thread Documentation system by crenz

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.