mirror of
https://github.com/nwchemgit/nwchem.git
synced 2026-07-21 14:35:21 -04:00
a6f4db6e11
At the moment this topic is wide open. Doxygen seems to be the more popular tool (in particular among C-programmers) and it puts more effort in to generate documentation. However on a code as large as NWChem it suffers from segmentation faults. Robodoc simply extracts documentation from the source code comments. Hence it is more limited in its ability to extract information when the code hasn't been commented. However, as an advantage I haven't seen it crash on NWChem yet. The main reason for checking this stuff in a this point is that we ship it with the development tar-balls and if something does not work we can tell people how they can reproduce the problems we are hitting. Alternatively, this allows developers to play with this stuff as well. However, anyone playing with this must consider that we may choose another tool (or no tool at all) as some point in the future. Hence putting a lot of work into the documentation at this point is unwise.
24 lines
791 B
Text
24 lines
791 B
Text
ROBODOC README
|
|
==============
|
|
|
|
This directory contains experimental material to generate source code
|
|
documentation using Robodoc.
|
|
|
|
To generate the source code documentation run
|
|
|
|
cd $NWCHEM_TOP
|
|
./contrib/robodoc/run_robodoc
|
|
|
|
After this $NWCHEM_TOP/srcdoc.html should contain the source code documentation
|
|
of all of NWChem. As currently very few (i.e. no) files contain the appropriate
|
|
comments that Robodoc recognizes this file will be small.
|
|
|
|
Experience so far has shown Robodoc to be stable and capable to handle a
|
|
large code. How the tool will behave if a large fraction of the source code
|
|
is documented is unknown.
|
|
|
|
For more details on Robodoc see:
|
|
|
|
- http://sourceforge.net/projects/robodoc/ -- project pages
|
|
- http://www.xs4all.nl/~rfsber/Robo/robodoc.html -- general info
|
|
|