Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change
 
PerlMonks  

Re: Documentation system

by jimbojones (Friar)
on Oct 08, 2004 at 16:28 UTC ( #397699=note: print w/replies, xml ) Need Help??


in reply to Documentation system

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

Replies are listed 'Best First'.
Re^2: Documentation system
by Anonymous Monk on Oct 11, 2004 at 16:09 UTC
    After some googlification, I got a link to access all the files of DoxyFilt : ftp://ftp.doorways.org/doxyfilt Seems like the project is not maintained anymore though. - G.
      There is a somewhat recent version (a few months old), and after fixing two typos, it works rather well for me. I think I prefer this to OODoc, actually.

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://397699]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others drinking their drinks and smoking their pipes about the Monastery: (7)
As of 2023-01-30 11:09 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?