Misc. Doxygen configuration changes

- Adjust Doxygen preprocessor behavior such that it actually parses
  #ifdefs in the code.  Otherwise, some parts of the SIMD code seemed to
  get ignored.
- Extract static functions on all levels of documentation for
  consistency (and we may end up with some static inline members in
  public headers; currently at least vec.h qualifies).
- Remove unnecessary excludes now that VERBATIM_HEADERS=NO already
  excludes the unwanted files.
- Some other minor cleanup.
- Move member groups higher up in the layouts, since they generally are
  the most interesting part.

Change-Id: Iea04772628716ed12f44cd4465c2027f4670bfae

diff --git a/doxygen/Doxyfile-common.cmakein b/doxygen/Doxyfile-common.cmakein
index e8c132e26fe1dc28f58772258f32cf0db2d69b69..6887c06d79be1b0b40bd01f856dea019f9fee324 100644 (file)
--- a/doxygen/Doxyfile-common.cmakein
+++ b/doxygen/Doxyfile-common.cmakein
@@ -27,7 +27,6 @@ MSCGEN_PATH            = @DOXYGEN_MSCGEN_PATH@
 ENABLED_SECTIONS       = @DOXYGEN_SECTIONS@
 
 MACRO_EXPANSION        = YES
-EXPAND_ONLY_PREDEF     = YES
 # Extract documentation also for code in headers within #ifdef __cplusplus
 PREDEFINED             = __cplusplus
 # This is for thread_mpi to #ifdef some code out that should not be documented.
@@ -51,6 +50,8 @@ VERBATIM_HEADERS       = NO
 STRIP_CODE_COMMENTS    = NO
 
 EXTRACT_LOCAL_CLASSES  = NO
+# This includes 'static inline' functions from headers in the documentation.
+EXTRACT_STATIC         = YES
 
 ALIASES               += Gromacs=GROMACS
 

diff --git a/doxygen/Doxyfile-full.cmakein b/doxygen/Doxyfile-full.cmakein
index 269b78783896921f6d42da931581836b5cdec8dd..6b447d68592c00c507043e8e43a9fb071f9300ec 100644 (file)
--- a/doxygen/Doxyfile-full.cmakein
+++ b/doxygen/Doxyfile-full.cmakein
@@ -1,12 +1,9 @@
 @INCLUDE               = Doxyfile-common
 
-MACRO_EXPANSION        = YES
-EXPAND_ONLY_PREDEF     = YES
 PREDEFINED            += F77_FUNC(name,NAME)=name
 
 ENABLED_SECTIONS      += libapi internal
 INTERNAL_DOCS          = YES
-EXTRACT_STATIC         = YES
 EXTRACT_LOCAL_CLASSES  = YES
 EXTRACT_ANON_NSPACES   = YES
 HIDE_UNDOC_CLASSES     = YES

diff --git a/doxygen/Doxyfile-lib.cmakein b/doxygen/Doxyfile-lib.cmakein
index f2e40f9b15f1bfd282d1d06a129b207692c841f1..497e358c1065df41bc372c52c06555893eb03d09 100644 (file)
--- a/doxygen/Doxyfile-lib.cmakein
+++ b/doxygen/Doxyfile-lib.cmakein
@@ -2,8 +2,6 @@
 
 ENABLED_SECTIONS      += libapi
 INTERNAL_DOCS          = NO
-# This includes 'static inline' functions from headers in the documentation.
-EXTRACT_STATIC         = YES
 HIDE_UNDOC_CLASSES     = YES
 WARN_LOGFILE           = doxygen-lib.log
 HTML_OUTPUT            = html-lib

diff --git a/doxygen/Doxyfile-user.cmakein b/doxygen/Doxyfile-user.cmakein
index dbdd555e058836d360b6ccb386200ee1ebb66752..d2acd5fc5ab106589b352d04963d3bfd84630d0c 100644 (file)
--- a/doxygen/Doxyfile-user.cmakein
+++ b/doxygen/Doxyfile-user.cmakein
@@ -1,9 +1,7 @@
 @INCLUDE               = Doxyfile-common
 
-# There is no public API documentation here;
-# exclude them from the generated file list
-EXCLUDE               += @CMAKE_SOURCE_DIR@/src/programs
-EXCLUDE               += @CMAKE_SOURCE_DIR@/src/testutils
+# These pages include documentation that does not belong to the public API
+# documentation; exclude them from the generated documentation
 EXCLUDE               += @CMAKE_SOURCE_DIR@/doxygen/doxygen.md
 EXCLUDE               += @CMAKE_SOURCE_DIR@/doxygen/unittesting.md
 EXCLUDE               += @CMAKE_SOURCE_DIR@/doxygen/wrapperbinary.md

diff --git a/doxygen/DoxygenLayout.xml b/doxygen/DoxygenLayout.xml
index 09a5090751f192f78a358484510715c9b4dee866..55e292d1e6a79c9cd2455854cc104fa900eb3ad0 100644 (file)
--- a/doxygen/DoxygenLayout.xml
+++ b/doxygen/DoxygenLayout.xml
@@ -114,6 +114,7 @@
     <sourcelink visible="yes"/>
     <detaileddescription title="Description"/>
     <memberdecl>
+      <membergroups visible="yes"/>
       <classes visible="yes" title=""/>
       <namespaces visible="no" title=""/>
       <constantgroups visible="yes" title=""/>
@@ -122,7 +123,6 @@
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
-      <membergroups visible="yes"/>
     </memberdecl>
     <memberdef>
       <inlineclasses title=""/>
@@ -143,6 +143,7 @@
     <memberdecl>
       <nestedgroups visible="yes" title=""/>
       <namespaces visible="yes" title=""/>
+      <membergroups visible="yes"/>
       <classes visible="yes" title=""/>
       <defines title=""/>
       <typedefs title=""/>
@@ -159,7 +160,6 @@
       <friends title=""/>
       <dirs visible="yes" title=""/>
       <files visible="yes" title=""/>
-      <membergroups visible="yes"/>
     </memberdecl>
     <memberdef>
       <pagedocs/>