Re: documentation generator? web-enabled perldoc?

Check out Pod::Webserver. It scans the perl installation and runs a web server which serves pod formatted as HTML.

I also use a simple script to create a syntax-highlighted source code listings and an index page. It uses gvim to make syntax-highlighted listings in HTML. I wrote a little script to create these highlighted listings in a batch mode. The script also makes an index page. It runs so slowly that when the first file being processed was large, I was fooled into thinking it was broken!

There are several ongoing projects that are relevant. TheDamian is working on something a bit like JavaDoc. It parses specially formatted comments and turns them into documentation. I don't have the details handy, but I can post a few notes later if there is interest.

There is at least one perl refactoring tool in the works, but it is still in the research phase. To work properly it must parse perl itself, which is properly understood as a very hard problem. I have seen this tool handle subs and packages and draw depedency diagrams. This was demonstrated (in part) by MikeZone at a Sonoma.pm Mongers meeting.

It should work perfectly the first time! - toma

Comment on Re: documentation generator? web-enabled perldoc?

Replies are listed 'Best First'.
Re^2: documentation generator? web-enabled perldoc? by geektron (Curate) on Aug 07, 2004 at 15:22 UTC
POD::Webserver is closer to what i need to have as an end result. in the words of the PHB: "It must be searchable". i keep trying to get him to calm down, that we need content before content can be searchable. I'd like to see what TheDamian is working on. maybe i should ping him and see if there's interest in collaboration. working on anything withy him would be an invaluable learning experience (and cheaper than hallucinogenic drugs!)	[reply]

Replies are listed 'Best First'.

Re^2: documentation generator? web-enabled perldoc?
by geektron (Curate) on Aug 07, 2004 at 15:22 UTC

in the words of the PHB: "It must be searchable". i keep trying to get him to calm down, that we need content before content can be searchable.

I'd like to see what TheDamian is working on. maybe i should ping him and see if there's interest in collaboration. working on anything withy him would be an invaluable learning experience (and cheaper than hallucinogenic drugs!)

[reply]