|Keep It Simple, Stupid|
Perl Documentation, again. :(by Seventh (Beadle)
|on Mar 23, 2005 at 15:40 UTC||Need Help??|
Seventh has asked for the
wisdom of the Perl Monks concerning the following question:
One thing that's frustrating to people new to open source stuff is that the documentation is more often than not way too focused on "Look what my wonderful application does" and not "By the way, here's how you use it."
That being said, for months now I've been trying to get various perl doc tools to work. I've tried OODoc, ePod, docgen, pdoc, and Doxygen with a few opensource filters.
Today I tried pdoc. The documentation is basically "It's great. Type make, then make install, then make test!".
That's it for the readme. Here is the post on here about it. Certainly sounds lovely doesn't it? Well apparently it's not meant to be used by newbies, because nobody ever seems to bother to say "Here is how you actually execute my wonderful program". I'm sure it's common knowledge to most of you, but for those of us just starting out, I don't understand how we're supposed to figure this out without at least someone, somewhere saying "Hey, this is how you do it, and it will apply going forward".
Anyhow, sorry for the vent, but if anyone can tell me how to use, for example, pdoc with my scripts, I'll fedex you a puppy. I've got it installed. I have a script in a folder that I want to generate POD from. Where from here?