Misc. Doxygen improvements.
authorTeemu Murtola <teemu.murtola@cbr.su.se>
Fri, 19 Aug 2011 17:08:48 +0000 (20:08 +0300)
committerTeemu Murtola <teemu.murtola@cbr.su.se>
Thu, 25 Aug 2011 18:02:42 +0000 (21:02 +0300)
commit9ecf2f43ce35036d35965b3499fd3acb6db1de98
tree995ee7bb5bbd08d6d0daa943e719ab0aa80851f8
parent6bdae463549326c657baae1d7308dca1c955372b
Misc. Doxygen improvements.

- Excluded src/external/ from Doxygen documentation.
- Made inherited members appear in class documentation. Makes API
  documentation easier to read if there are many public members
  inherited from base classes.
- Added conditional sections for Doxygen that can be used in addition to
  \internal and \libinternal.
- Consolidated use of \internal and \libinternal in file comments:
  all installed (=public API) headers now produce some documentation for
  the public API, even if the file only contains declarations that are
  not directly in the public API.
- Added short file documentation for a few files where it was missing.

Gromacs wiki has also been updated with the changes.

Related to IssueIDs #638 and #662.

Change-Id: I9ffb9d68752697b5b58a3cc4ae45d802e32cf45c
23 files changed:
Doxyfile-lib.cmakein
Doxyfile-user.cmakein
Doxyfile.cmakein
src/gromacs/analysisdata/abstractdata.h
src/gromacs/analysisdata/arraydata.h
src/gromacs/analysisdata/datamodule.h
src/gromacs/analysisdata/modules/plot.h
src/gromacs/analysisdata/tests/mock_module.h
src/gromacs/fatalerror/exceptions.h
src/gromacs/legacyheaders/mainpage.h [deleted file]
src/gromacs/options/abstractoption.h
src/gromacs/options/optionflags.h
src/gromacs/trajectoryanalysis/modules/angle.cpp
src/gromacs/trajectoryanalysis/modules/angle.h
src/gromacs/trajectoryanalysis/modules/distance.cpp
src/gromacs/trajectoryanalysis/modules/distance.h
src/gromacs/trajectoryanalysis/modules/select.cpp
src/gromacs/trajectoryanalysis/modules/select.h
src/gromacs/utility/CMakeLists.txt
src/gromacs/utility/flags.h
src/testutils/datapath.cpp
src/testutils/datapath.h
src/testutils/refdata.h