Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl-Sensitive Sunglasses
 
PerlMonks  

Re: creating documentation

by planetscape (Chancellor)
on Dec 27, 2005 at 15:34 UTC ( [id://519346]=note: print w/replies, xml ) Need Help??


in reply to creating documentation

One tool I especially like is DoxyFilt* (Doxygen for Perl).

These nodes might also help if you are searching for tools:


Analyzing large Perl code base.
Becoming familiar with a too-big codebase?

This might sound like stating the bleeding obvious, but make certain the examples in your Synopsis actually work... I've run across my fair share that don't.

Also, in most cases, your user wants output (maybe this doesn't apply precisely to your case, but here goes anyway) - if it's non-obvious how to get output from your program, specify how to do it. Some modules I've come across have specialized print functions... some have really obscure methods... don't force your user to use Data::Dumper on likely-looking variables from your POD in vain attempts to get results.

HTH,

* Update: 2005-12-28 Kudos to both john_oshea and tfrayner for alerting me to the fact that my link above has been rendered usless by the foul creatures known as spammers... I have found what appears to be a good link to obtain DoxyFilt; the most recent version seems to be from August 24, 2005: Doxygen-0.84.tar.gz. Thanks again, guys!

planetscape

Replies are listed 'Best First'.
Re^2: creating documentation
by tfrayner (Curate) on Dec 28, 2005 at 11:37 UTC
    Hi,

    I've seen DoxyFilt recommended here before, but the wiki link you gave here seems to have been spammed with random drug ads for some time. There's an old version available still, but is there a new link for the project?

    Cheers,
    Tim

      Thanks for the reply. The sharp-eyed john_oshea also caught this one... I am currently checking to see what I can find on DoxyFilt, because it is, IMHO, a valuable addition to one's toolbox. I'll post back here with my results. :-)

      HTH,

      Update: 2005-12-28 Kudos to both john_oshea and tfrayner for alerting me to the fact that my link above has been rendered usless by the foul creatures known as spammers... I have found what appears to be a good link to obtain DoxyFilt; the most recent version seems to be from August 24, 2005: Doxygen-0.84.tar.gz. Thanks again, guys!

      planetscape

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others sharing their wisdom with the Monastery: (4)
As of 2024-03-29 12:23 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found