A simple gawk script to interpret Doxygen comments in ADMB template files.
Doxygen and gawk
must be installed on your computer.
You will probably need a working version of ADMB, too.
-
Include the following setting in your Doxyfile:
FILTER_PATTERNS = *.tpl=tpl2dox.sh
for linux, or
FILTER_PATTERNS = *.tpl=tpl2dox.bat
for Windoze, and add your ADMB template file to the INPUT
setting, e. g.,
INPUT = simple.tpl
-
Ensure the tpl2dox script is in the same directory as Doxyfile so that it is visible to doxygen.
-
Block comments are not supported for variables. Use
///<
to open an in line Doxygen comment to document variables in theDATA_SECTION
andPARAMETER_SECTION
. -
Doxygen comment blocks, such as those to document FUNCTIONs, should be opend with
/**
and closed with*/
. The other comment block delimiters are not supported. -
Comment blocks shoud start in column 3 in accordance with standard ADMB coding practice.
-
tpl2dox
does not work correctly in all cases. Occasionally functions appear in places where variables should appear. The comment blocks for certain FUNCTIONs do not appear. -
Run
tpl2cpp
to make sure your comments blocks have not buggered up the.tpl
file format.
Here are a few examples drawn from the standard suite of ADMB examples. Some work well; some don't.