Add documentation for using Doxygen
authorTeemu Murtola <teemu.murtola@gmail.com>
Sun, 9 Feb 2014 12:15:32 +0000 (14:15 +0200)
committerGerrit Code Review <gerrit@gerrit.gromacs.org>
Thu, 20 Feb 2014 05:11:29 +0000 (06:11 +0100)
commitb8f4cb8a0c818f24782e4cf3c258d856bac39550
treee10c29c5051ad3faeb1e17941fb11170c010e512
parentf3acafa0e702fdceee6e004e84b897912904aa17
Add documentation for using Doxygen

- Add a page that provides guidelines and examples for using Doxygen.
  Hopefully, this would make simple examples easier to find, and help
  people write correct comments from the beginning.
- Remove unnecessary \addtopublicapi and \addtolibraryapi.

Once the contents are there, it is easy to enhance the documentation by
adding content whenever noticing things that are tricky.

Change-Id: I319e30452004998df73c249f46570cb2254daa87
13 files changed:
.gitattributes
doxygen/Doxyfile-common.cmakein
doxygen/Doxyfile-full.cmakein
doxygen/Doxyfile-lib.cmakein
doxygen/Doxyfile-user.cmakein
doxygen/doxygen.md [new file with mode: 0644]
doxygen/examples/doxygen-example-issues.cpp [new file with mode: 0644]
doxygen/examples/doxygen-example-module.cpp [new file with mode: 0644]
doxygen/examples/doxygen-example-scoping.cpp [new file with mode: 0644]
doxygen/examples/doxygen-example.c [new file with mode: 0644]
doxygen/examples/doxygen-example.cpp [new file with mode: 0644]
doxygen/mainpage.md
src/gromacs/utility/gmxassert.h