Beefy Boxes and Bandwidth Generously Provided by pair Networks
go ahead... be a heretic

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

Hello felow Monks,

Iīm trying to find a documentation generator for various languages as PL/SQL, C++, Pro*C etc..

There are lots of tools to generate this kind of documentation separately. What i was hoping to find was a tool that can generate good documentation of several languages!

This migth be not a perl question, but i have been wondering in another solution, that is to use the perlpod!! If i include the perlīs pod tags in a source code i could easily create good documentation with some style.

For example in a PL/SQL code:

/* =pod =head1 Title Documentation for program YXZ.sql =cut */

The only inconvenience in this approach is the fact that i have to tell the programmers to use this tags.. and give them the list to explain it. And i donīt know if they will accept this "protocol".

So, i think that the best option is to find a tool that generates html code.

Does someone knows such a tool or has any advices?

Thank you all!


In reply to Doc Generator by nofernandes

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 or How to display code and escape characters are good places to start.
Log In?

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

How do I use this? | Other CB clients
Other Users?
Others scrutinizing the Monastery: (2)
As of 2021-12-05 16:26 GMT
Find Nodes?
    Voting Booth?
    R or B?

    Results (31 votes). Check out past polls.