Beefy Boxes and Bandwidth Generously Provided by pair Networks
Come for the quick hacks, stay for the epiphanies.
 
PerlMonks  

Re^2: documentation generator? web-enabled perldoc?

by geektron (Curate)
on Aug 07, 2004 at 15:36 UTC ( [id://380922]=note: print w/replies, xml ) Need Help??


in reply to Re: documentation generator? web-enabled perldoc?
in thread documentation generator? web-enabled perldoc?

yes, i think we all know how you feel about POD. ;-)

i've thought of something like POD on steroids. pod2html is a nice start for web-enabling the whole thing, and some kind of (ack!) custom parser could generate the meta-data to shove info into a database and "make it searchable" (so could something like htdig, but i worry about false positive and things like that just from a full-text search ).

i like POD, but POD does have its limitations. one of the main limitiations being that any 'cross-references' (like function Foo::bar called by package Bar::baz ) has to be done by hand. for an undocumented application that's sliced way too thin ... that's going to be a nightmare.

( the app author seriously has modules like:
Application::Mailer::Mailer::SendMail
which does NOTHING but accept a stringified MIME::Lite message ( from  $obj->as_string() ), open a SENDMAIL pipe, and print to that pipe. i don't know about everyone else, but that's a bit too sliced for my taste.

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others studying the Monastery: (5)
As of 2024-04-24 23:20 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found