Fix documentation of swap/enums.h

Another issue picked up by the doxygen documentation checker.

Change-Id: Ieaad04e713bb045a018823d26983dea1d52b202f

diff --git a/doxygen/suppressions.txt b/doxygen/suppressions.txt
index 43da03ab42064e7b06708dfd5bbf97aa7a687b63..4f4c5ca11d856498838153e1a15c4d1330b98ebb 100644 (file)
--- a/doxygen/suppressions.txt
+++ b/doxygen/suppressions.txt
@@ -10,7 +10,6 @@ share/template/template.cpp: error: source file documentation appears outside fu
 : error: no matching directory for module: module_mdrun_integration_tests
 
 # These are real documentation issues that should be fixed
-src/gromacs/legacyheaders/types/*.h: warning: included file "../../swap/enums.h" is not documented as exposed outside its module
 
 # These would be nice to fix, but can wait for later
 *: warning: includes local file as <config.h>

diff --git a/src/gromacs/swap/enums.h b/src/gromacs/swap/enums.h
index 4066a9dc3814791c35242735c95dccb684a3b8ff..8a4ddd16d5be0072fc71569f85bc6a3e74994b15 100644 (file)
--- a/src/gromacs/swap/enums.h
+++ b/src/gromacs/swap/enums.h
@@ -32,6 +32,19 @@
  * 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
+ * \brief
+ * Enumerated types used in the "Computational Electrophysiology" module.
+ *
+ * The following enums are mainly used for indexing arrays and when
+ * looping over the available ions, channels, or compartments. This hopefully
+ * adds to the code's readability because it makes clear which object is dealt
+ * with in a block of code.
+ *
+ * \author Carsten Kutzner <ckutzne@gwdg.de>
+ * \inlibraryapi
+ * \ingroup module_swap
+ */
 #ifndef GMX_SWAP_ENUMS_H_
 #define GMX_SWAP_ENUMS_H_
 
@@ -39,23 +52,23 @@
 extern "C" {
 #endif
 
-/* The following three enums are mainly used for indexing arrays and when
- * looping over the available ions, channels, or compartments. This hopefully
- * adds to the code's readability because it makes clear which object is dealt
- * with in a block of code.
- *
- * The two compartments for CompEL setups */
+/*! \brief The two compartments for CompEL setups. */
 enum eCompartment {
     eCompA, eCompB, eCompNR
 };
-/* The positive and negative ions CompEL setups, future versions of the
- * protocol might consider more than two types of ions */
+
+/*! \brief The positive and negative ions CompEL setups.
+ *
+ * Future versions of the protocol might consider more than two types of ions.
+ */
 enum eIontype {
     eIonNEG, eIonPOS, eIonNR
 };
-/* The chanels that define with their COM the compartment boundaries in
- * CompEL setups. In principle one could also use modified setups with
- * more than two channels. */
+
+/*! \brief The channels that define with their COM the compartment boundaries in CompEL setups.
+ *
+ * In principle one could also use modified setups with more than two channels.
+ */
 enum eChannel {
     eChan0, eChan1, eChanNR
 };