Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister
 
PerlMonks  

Re: Natural Doc - Create fancy documentation for your Perl code.

by MidLifeXis (Monsignor)
on Oct 17, 2006 at 17:49 UTC ( [id://578858]=note: print w/replies, xml ) Need Help??


in reply to Natural Doc - Create fancy documentation for your Perl code.

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

Replies are listed 'Best First'.
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]

      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]

In Section Cool Uses for Perl

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?

www.com | www.net | www.org
Node Status?
node history
Node Type: note [id://578858]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? • Last hour • Other CB clients
Other Users?
Others exploiting the Monastery: (5)
As of 2024-04-19 13:59 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found