best approach is probably to build one file at a time, not try to 'auto-document' the whole code-base (resulting in useless documentation).
Doxygen multiple source directories code#
Support for open-source community: example of well-documented source (using doxygen) that community can follow if they want to document the source (not making code changes).Doesnt seem to allow documenting csh scripts.What modules should be created for freesurfer? group by utility type? ie volume, surface, display The second section (the author name, CVS info and copyright message) is not read by Doxygen.ĭoxygen supports grouping things together: is the one-line summary, and the REPLACE_WITH_LONG_DESCRIPTION_OR_REFERENCE line can be multiple lines describing the file in detail, or at least include a reference to a paper describing the techniques used, if applicable. items should be updated when this header is included at the top of a source file. * in the file 'LICENSE' found in the FreeSurfer distribution, and here:
Doxygen multiple source directories software license#
* are found in the 'FreeSurfer Software License Agreement' contained * Terms and conditions for use, reproduction, distribution and contribution * Copyright © 2011 The General Hospital Corporation (Boston, MA) "MGH" * Original Author: REPLACE_WITH_FULL_NAME_OF_CREATING_AUTHOR * REPLACE_WITH_LONG_DESCRIPTION_OR_REFERENCE * REPLACE_WITH_ONE_LINE_SHORT_DESCRIPTION The stub file header supporting Doxygen, used in the freesurfer code base, and the contents of which are found in dev/doxy-file-header, is this: /**
To generate the html and latex docs, where $FSDEV is your git checkout, type: cd $FSDEV Because virtually none of the freesurfer source files have any doxygen tags, the html output produced by doxygen is mostly useless junk, or missing vast numbers of file. Notice just the utils directory is marked to be processed. The defaults that have been changed are the following: 20c20 A default is created by typing: doxygen -g
Step 1 in using doxygen is the creation of a config file. It can generate html docs documenting a projects source code, by either extracting special tags from the source code (put there by people wanting to make use of doxygen), or doxygen attempts to build documentation from existing source.ĭoxygen seems to be installed on the NMR systems, type: doxygen -version This page is for notes on using Doxygen to document the Freesurfer source code.ĭoxygen,, is a documentation system for C++, C, Java, and some other weird languages.
0 kommentar(er)
