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.
102 lines
1.5 KiB
Text
102 lines
1.5 KiB
Text
# Robodoc configuration file for the documentation of DL-FIND
|
|
#
|
|
items:
|
|
NAME
|
|
FUNCTION
|
|
SYNOPSIS
|
|
INPUTS
|
|
OUTPUTS
|
|
COMMENTS
|
|
DATA
|
|
SIDE EFFECTS
|
|
HISTORY
|
|
BUGS
|
|
COPYRIGHT
|
|
PORTABILITY
|
|
ignore items:
|
|
HISTORY
|
|
BUGS
|
|
COPYRIGHT
|
|
SOURCE
|
|
item order:
|
|
NAME
|
|
SYNOPSIS
|
|
INPUTS
|
|
OUTPUTS
|
|
FUNCTION
|
|
source items:
|
|
SYNOPSIS
|
|
INPUTS
|
|
OUTPUTS
|
|
preformatted items:
|
|
DATA
|
|
format items:
|
|
FUNCTION
|
|
SIDE EFFECTS
|
|
options:
|
|
--src src
|
|
--doc srcdoc
|
|
--html
|
|
# --nosort
|
|
--singledoc
|
|
--sections
|
|
--index
|
|
--toc
|
|
--tabsize 8
|
|
--syntaxcolors
|
|
--documenttitle "NWChem Source Documentation"
|
|
--nopre
|
|
# --css contrib/robodoc/robodoc.css
|
|
headertypes:
|
|
J "Projects" robo_projects 2
|
|
F "Files" robo_files 1
|
|
e "Makefile Entries" robo_mk_entries
|
|
x "System Tests" robo_syst_tests
|
|
q Queries robo_queries
|
|
ignore files:
|
|
README
|
|
CVS
|
|
.svn
|
|
*.bak
|
|
*~
|
|
"a test_*"
|
|
accept files:
|
|
*.f90
|
|
*.f
|
|
*.fh
|
|
*.F
|
|
*.c
|
|
header separate characters:
|
|
,
|
|
header ignore characters:
|
|
[
|
|
remark markers:
|
|
c
|
|
*
|
|
remark begin markers:
|
|
/*
|
|
remark end markers:
|
|
*/
|
|
header markers:
|
|
****
|
|
c****
|
|
end markers:
|
|
******
|
|
c******
|
|
source line comments:
|
|
//
|
|
keywords:
|
|
if
|
|
else
|
|
end
|
|
do
|
|
end do
|
|
enddo
|
|
select
|
|
end select
|
|
case
|
|
while
|
|
for
|
|
subroutine
|
|
function
|
|
call
|