Upgrade layout file to support Doxygen >=1.8.

Remove entries in the layout file that cause warnings with Doxygen >=1.8
Split the layout file changes into two parts to allow upgrading Doxygen
without breaking existing builds; after this change, the layout file
does not produce warnings with either version, but needs additional
changes to fully conform to what at least 1.8.5 expects (those included
in Ie265644).  Jenkins needs to be updated for this to be useful; until
that is done, some links etc. in the generated documentation may subtly
break.

Also fixed a stray Doxygen warning with 1.8.5.

Related to #1239.

Change-Id: Ieb7d4441ba8f6e6ffde042e20fc51598b3029439

diff --git a/doxygen/Doxyfile-common.cmakein b/doxygen/Doxyfile-common.cmakein
index cad41dd3254f3db958e8bd3a1f4bd4615577c346..760295b4dfdcdcec7bf383a825d20157d6affa71 100644 (file)
--- a/doxygen/Doxyfile-common.cmakein
+++ b/doxygen/Doxyfile-common.cmakein
@@ -38,7 +38,6 @@ BUILTIN_STL_SUPPORT    = YES
 INLINE_INHERITED_MEMB  = YES
 SORT_BY_SCOPE_NAME     = YES
 ALPHABETICAL_INDEX     = YES
-SHOW_DIRECTORIES       = YES
 HTML_DYNAMIC_SECTIONS  = YES
 GENERATE_LATEX         = NO
 

diff --git a/doxygen/DoxygenLayout.xml b/doxygen/DoxygenLayout.xml
index 607b6aa9ab6f06ce7bc759e2d51a5e2637381326..c42c783b961c021b392bdde919edf3f661ef5b86 100644 (file)
--- a/doxygen/DoxygenLayout.xml
+++ b/doxygen/DoxygenLayout.xml
@@ -18,7 +18,6 @@
       <tab type="filelist" visible="yes" title="" intro=""/>
       <tab type="globals" visible="yes" title="" intro=""/>
     </tab>
-    <tab type="dirs" visible="yes" title="" intro=""/>
     <tab type="examples" visible="yes" title="" intro=""/>
   </navindex>
 

diff --git a/src/gromacs/onlinehelp/helpwritercontext.cpp b/src/gromacs/onlinehelp/helpwritercontext.cpp
index 0dc471cb9f63f95b014b579de425998af2acdd27..db85fcbd773ead68ba9324584a7e9720476844f1 100644 (file)
--- a/src/gromacs/onlinehelp/helpwritercontext.cpp
+++ b/src/gromacs/onlinehelp/helpwritercontext.cpp
@@ -63,7 +63,7 @@ namespace gmx
 namespace
 {
 
-/*! \internal \brief
+/*! \brief
  * Custom output interface for HelpWriterContext::Impl::processMarkup().
  *
  * Provides an interface that is used to implement different types of output
@@ -88,7 +88,7 @@ class WrapperInterface
         virtual void wrap(const std::string &text)  = 0;
 };
 
-/*! \internal \brief
+/*! \brief
  * Wraps markup output into a single string.
  *
  * \ingroup module_onlinehelp
@@ -118,7 +118,7 @@ class WrapperToString : public WrapperInterface
         std::string             result_;
 };
 
-/*! \internal \brief
+/*! \brief
  * Wraps markup output into a vector of string (one line per element).
  *
  * \ingroup module_onlinehelp
@@ -149,12 +149,14 @@ class WrapperToVector : public WrapperInterface
         std::vector<std::string> result_;
 };
 
-/*! \internal \brief
+/*! \brief
  * Make the string uppercase.
  *
  * \param[in] text  Input text.
  * \returns   \p text with all characters transformed to uppercase.
  * \throws    std::bad_alloc if out of memory.
+ *
+ * \ingroup module_onlinehelp
  */
 std::string toUpperCase(const std::string &text)
 {