Beefy Boxes and Bandwidth Generously Provided by pair Networks
There's more than one way to do things
 
PerlMonks  

Doc Generator

by nofernandes (Beadle)
on Aug 05, 2003 at 16:49 UTC ( #281072=perlquestion: print w/replies, xml ) Need Help??
nofernandes has asked for the wisdom of the Perl Monks concerning the following question:

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!

Nuno

Replies are listed 'Best First'.
Re: Doc Generator
by Cine (Friar) on Aug 05, 2003 at 17:52 UTC
    You can also look at Doxygen...

    T I M T O W T D I
Re: Doc Generator
by Aristotle (Chancellor) on Aug 05, 2003 at 17:11 UTC

    Maybe JavaDoc would be helpful? (Despite its name, applicable to languages other than Java.)

    See Re^5: Doc Generator.

    Makeshifts last the longest.

      Hmm.. do you mean that i can use the javadoc format in for example a C++ program and then execute the javadoc filename.c? And then i get the html documentation?

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: perlquestion [id://281072]
Approved by hsmyers
help
Chatterbox?
[ambrus]: Like <c>{ package AnyEvent::Impl:: Prima; use Prima; sub io{ my($s,%r)=@_; Prima::File->new( file=>$r{fh},mask =>("w"eq$r{poll}? fe::Write():fe:: Read())|fe:: Exception,onRead =>$r{cb},onWrite =>$r{cb}, onException=>$r{cb }) } sub timer { ... } push @AnyEvent::REGI
[ambrus]: argh, too long, let me try on scratchpad
[Corion]: . o O ( I seem to have improved my skills of getting other people to write code for me )
[ambrus]: ambrus's scratchpad

How do I use this? | Other CB clients
Other Users?
Others perusing the Monastery: (9)
As of 2016-12-08 12:43 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    On a regular basis, I'm most likely to spy upon:













    Results (141 votes). Check out past polls.