Marcus Rohrmoser wrote:
As we all know that's a pretty weak point still, ain't it? So I'd like to know if there's somebody working on that and who - I'd like to join him (her).
I do not know of any existing project in this field.
If there's nobody on that I'd like to know what you think about including the doc into the header and use a doc-tool - e.g. doc++
- to generate printable and html docu.
Is this something like the Linux SGML documentation system?
If I get no response, I'll assume there's no interest in documentation at all and skip this project.
IMHO there is a lot of need for documentation. To make GRX usable for Joe Average User who cannot derive how a function works from its source code, this is a necessity.
Peter
The document generators I think of work pretty much like 'javadoc'. They use comments starting with "/**" and produce e.g. html or latex output. Also I think this (javadoclike docu) maybe could become somewhat a standard for C/C++, too.
The formatter I'd use is doc++ (used this on a sun, but couldn't build it on DOS for an 'internal compiler-error' - help appreciated) or perceps, but I'm not fixed on that.
Please reply me your opinion on that.
Marcus
P.S.:
Possible formatters are
O.K. fellows, here's a collection of all the links (to free software) that friendly folks mailed to me.
Perceps (said to be perl-based) http://friga.mer.utexas.edu/mark/perl/perceps/ doc++ http://www.zib.de/Visual/software/doc++/ VisualParse++ http://www.sand-stone.com GDPro http://www.advancedsw.com George http://www.k2.co.uk/products/George/index.html OSE http://www.dscpl.com.au/ doxygen http://www.stack.nl/~dimitri/doxygen/ KDOC http://www.ph.unimelb.edu.au/~ssk/kde/kdoc/ cdoc (I didn't find it) http://www.mozilla.org cocoon http://www-users.cs.umn.edu/~kotula/cocoon/cocoon.htm cxx2html ftp://aips2.nrao.edu/pub/RELEASED/cxx2html
More may be listed in the C++ libraries FAQ: http://www.trumphurst.com/cpplibs1.html
Marcus Rohrmoser wrote:
The document generators I think of work pretty much like 'javadoc'. They use comments starting with "/**" and produce e.g. html or latex output. Also I think this (javadoclike docu) maybe could become somewhat a standard for C/C++, too.
JFYI: GRX already contains comments of this form.
The formatter I'd use is doc++ (used this on a sun, but couldn't build it on DOS for an 'internal compiler-error' - help appreciated) or perceps, but I'm not fixed on that.
The license conditions of doc++ are _almost_ GPL which is in some sense worse than a proprietary license ...
Please reply me your opinion on that.
IMHO, please go on, decide what is best, and do it. :-)
Peter
-
Marcus Rohrmoser -
Peter Gerwinski