comp-chem/NWChem
1
0
Fork 0
mirror of https://github.com/nwchemgit/nwchem.git synced 2026-07-21 06:25:21 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
NWChem/contrib/robodoc
History
Exact
Yuri Victorovich 7b3d60dce7 Fix bash shebangs: make /usr/bin/env find bash in paths 
This is needed on FreeBSD and other systems where bash isn't located in /bin/bash.
2021-11-07 14:06:22 -08:00
..
README HvD: Added some experimental scripts for source code documentation generation. 2012-03-09 02:53:09 +00:00
robodoc.rc HvD: Added some experimental scripts for source code documentation generation. 2012-03-09 02:53:09 +00:00
run_robodoc Fix bash shebangs: make /usr/bin/env find bash in paths 2021-11-07 14:06:22 -08:00

README 

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