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

Documentation system -- Important note on OODoc

by crenz (Priest)
on Oct 12, 2004 at 17:09 UTC ( #398605=note: print w/replies, xml ) Need Help??


in reply to Documentation system

A quick update in-between: I tried out OODoc, but I'm not sure whether it fits the bill. It's very module-oriented; I couldn't get it to include docs from my .pl files. I want to document the whole project, not just the classes. Still, I'll try to take further looks at it.

I have an important warning, though: OODoc can delete your files if you are not careful. The example given in the manpage will filter your source and replace the files with files without documentation. When I used that example, it replaced all my files with empty files :-( . Fortunately, I use Subversion, so that was not much of a problem. However, without a backup, these files would have been lost.

If you try out OODoc, make sure you work on a copy and use something like this

$doc->processFiles( source => $distdir, workdir => undef, version => '0.1');

instead of the call to processFiles in the manpage until you know and understand what OODoc does. This will keep your source files intact, AFAIK.

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others cooling their heels in the Monastery: (3)
As of 2023-02-05 19:53 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    I prefer not to run the latest version of Perl because:







    Results (32 votes). Check out past polls.

    Notices?