Natural Doc - Create fancy documentation for your Perl code.

Hey!

I just had to post about this little tool since it's so cool and I was looking for such for ages, and if it wasnt for pure chance, I wouldnt have found it and I would have tried to do my own version wasting time. So, to avoid others do the same "misstake", I post about it here.

Besides, its also MADE in Perl! How cool is that? :)

What am I talking about? Well, http://www.naturaldocs.org

So, I can just do:

# Function: myFunc
#
# Arguments:
#  1. - This object.
#  2. - Path to file.
sub myFunc {
  my ($self, $path) = @_;
}
[download]

Runing the tool on this you get some really fancy documentation. (Check out http://www.naturaldocs.org/documenting.html)

Well, thanks for your time and hope you like it.

/ Ace

Comment on Natural Doc - Create fancy documentation for your Perl code. Download Code

Replies are listed 'Best First'.
Re: Natural Doc - Create fancy documentation for your Perl code. by zentara (Archbishop) on Oct 17, 2006 at 12:51 UTC
It works, but I must admit it produces information overload for my feeble mind.... all these links, fancy names, and licenses. However, it's output would be perfect for B.S.-ing your boss that you've been working hard on that project. :-) I'm not really a human, but I play one on earth. Cogito ergo sum a bum	[reply]
Re^2: Natural Doc - Create fancy documentation for your Perl code. by Ace128 (Hermit) on Oct 17, 2006 at 14:07 UTC
Well, it helped me organizing some script I did with alot of functions in it! ;) Also nice to use if you wanna have overview of the script(s) you have.	[reply]
Re: Natural Doc - Create fancy documentation for your Perl code. by MidLifeXis (Monsignor) on Oct 17, 2006 at 17:49 UTC
One gripe that I have is that ND (at least the version I have) is not able to use POD ~~in any form~~ that can be parsed by `perldoc`. I do not want to write my documentation twice, and ND forces me to write it twice - once for perldoc and once for the generated documentation. Otherwise, it is a pretty good system. Update: Poor implication of original wording. ~~remove~~ and add --MidLifeXis	[reply] [d/l]
Re^2: Natural Doc - Create fancy documentation for your Perl code. by Ace128 (Hermit) on Oct 17, 2006 at 21:21 UTC
Well, accoring to the http://www.naturaldocs.org/documenting.html: `Perl users can use POD to do block comments. =begin nd Function: Multiply Multiplies two integers and returns the result. =cut =nd Function: Multiply Multiplies two integers and returns the result. =cut` [download]	[reply] [d/l]
Re^3: Natural Doc - Create fancy documentation for your Perl code. by MidLifeXis (Monsignor) on Oct 18, 2006 at 16:48 UTC
But if I want to have it show up under perldoc, I still have to write it twice. `=begin nd` blocks do not get passed through to the default perldoc formatters, only to ND. --MidLifeXis	[reply] [d/l]
Re: Natural Doc - Create fancy documentation for your Perl code. by planetscape (Chancellor) on Oct 20, 2006 at 02:23 UTC
Personally, I recommend Doxygen. Doxygen generates JavaDoc-like documentation for projects in many languages, including C and C++. DoxygenFilter is a new take on an old project (DoxyFilt) that also handles ("filters") Perl code (including POD), and now promises support for multi-programming-language projects. See Examples of output generated by doxygen, or here. HTH, planetscape	[reply]


"be consistent"
	PerlMonks