Beefy Boxes and Bandwidth Generously Provided by pair Networks
Your skill will accomplish
what the force of many cannot
 
PerlMonks  

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

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. */

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
instead of
* test2.pm

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":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others studying the Monastery: (6)
As of 2023-02-05 13:32 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    I prefer not to run the latest version of Perl because:







    Results (31 votes). Check out past polls.

    Notices?