Beefy Boxes and Bandwidth Generously Provided by pair Networks
good chemistry is complicated,
and a little bit messy -LW
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
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

In reply to Re: documentation generator? web-enabled perldoc? by toma
in thread documentation generator? web-enabled perldoc? by geektron

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others having an uproarious good time at the Monastery: (6)
As of 2024-03-28 14:52 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found