Clean up and fix issues in doc-check scripts
authorTeemu Murtola <teemu.murtola@gmail.com>
Thu, 3 Apr 2014 03:16:52 +0000 (06:16 +0300)
committerGerrit Code Review <gerrit@gerrit.gromacs.org>
Thu, 10 Apr 2014 14:03:00 +0000 (16:03 +0200)
commit667a8381d8f0208006f8265f52f4261f30b75e18
tree246a359c1406883dd68c8d1307452d4226f0de11
parent054373b339811618a8ddf68393ffa3a08995835f
Clean up and fix issues in doc-check scripts

- Some 'documentation' -> 'doc' replacements in method names to make
  lines shorter and to make method names more consistent.
- Make the checker work for members of anonymous namespaces.
- To achieve the above, add minimal modeling of namespaces and members
  to gmxtree.py, and model the parent compounds of members better in
  doxygenxml.py.
- Make the checker check also documentation that is ignored by Doxygen.
  This is now possible when anonymouns namespaces work.
  --check-ignored now only controls whether the ignored comments provoke
  a note or not.  This is not enabled currently, because it produces
  quite a lot of noise.
- Fix documentation issues in those ignored Doxygen comments (all the
  source code changes).
- Encapsulate some logic in gmxtree.py related to how the API type is
  handled in the case of legacy (undocumented) modules.  This simplifies
  the graph generation logic, and replaces a lot of the "legacy" edges
  with more descriptive edges: installed headers in legacy modules are
  now treated as public API headers.
- Add a basic legend to the module graph.

Change-Id: Ia4e83468548b361f37bdb8d35862e636d7abddd6
13 files changed:
doxygen/doxygen-check.py
doxygen/doxygenxml.py
doxygen/gmxtree.py
doxygen/graphbuilder.py
src/gromacs/gmxlib/cinvsqrtdata.c
src/gromacs/legacyheaders/gmx_omp_nthreads.h
src/gromacs/legacyheaders/nbnxn_cuda_data_mgmt.h
src/gromacs/legacyheaders/pmalloc_cuda.h
src/gromacs/legacyheaders/types/nb_verlet.h
src/gromacs/math/utilities.h
src/gromacs/mdlib/nbnxn_cuda/nbnxn_cuda.h
src/gromacs/random/random.h
src/gromacs/timing/walltime_accounting.h