Sort all includes in src/gromacs

[alexxy/gromacs.git] / src / gromacs / onlinehelp / helptopicinterface.h

diff --git a/src/gromacs/onlinehelp/helptopicinterface.h b/src/gromacs/onlinehelp/helptopicinterface.h
index 1c6926369fdceb45174d2515e307494f35e37a2e..2a6479ed273adfc8b2664fa89ea0a005f098a77e 100644 (file)
--- a/src/gromacs/onlinehelp/helptopicinterface.h
+++ b/src/gromacs/onlinehelp/helptopicinterface.h
@@ -32,7 +32,20 @@
  * To help us fund GROMACS development, we humbly ask that you cite
  * the research papers on the package. Check out http://www.gromacs.org.
  */
-/*! \file
+/*! \libinternal \defgroup module_onlinehelp Help Formatting for Online Help (onlinehelp)
+ * \ingroup group_utilitymodules
+ * \brief
+ * Provides functionality for formatting help text for console and other
+ * formats.
+ *
+ * This module provides helper functions and classes for formatting console
+ * help, as well as man pages and HTML help from the source code.  It should
+ * not be necessary to call any methods in this module outside the \Gromacs
+ * library.
+ *
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
+ */
+/*! \libinternal \file
  * \brief
  * Declares gmx::HelpTopicInterface.
  *
@@ -43,28 +56,22 @@
 #ifndef GMX_ONLINEHELP_HELPTOPICINTERFACE_H
 #define GMX_ONLINEHELP_HELPTOPICINTERFACE_H
 
-#include "../utility/uniqueptr.h"
+#include "gromacs/utility/uniqueptr.h"
 
 namespace gmx
 {
 
 class HelpWriterContext;
 
-/*! \brief
+/*! \libinternal \brief
  * Provides a single online help topic.
  *
- * \if libapi
  * Implementations of these methods should not throw, except that writeHelp()
  * is allowed to throw on out-of-memory or I/O errors since those it cannot
  * avoid.
  *
  * Header helptopic.h contains classes that implement this interface and make
  * it simple to write concrete help topic classes.
- * \endif
- *
- * This class is in a public header, and exposed through HelpTopicPointer, but
- * it is not intended to be used outside the library.  To access a help topic
- * with public API methods, use HelpManager.
  *
  * \inlibraryapi
  * \ingroup module_onlinehelp