Fix several doxygen errors
authorJoe Jordan <ejjordan12@gmail.com>
Tue, 18 May 2021 10:50:09 +0000 (10:50 +0000)
committerPaul Bauer <paul.bauer.q@gmail.com>
Tue, 18 May 2021 10:50:09 +0000 (10:50 +0000)
src/gromacs/domdec/reversetopology.h
src/gromacs/mdlib/settle_gpu.h
src/gromacs/mdlib/update_constrain_gpu_internal.h
src/gromacs/mdtypes/fcdata.h

index 62568fe6fa9da9c66600d1f439e7354945d20bb3..0b9359b4b1c22b50667416ab457514e19d972786 100644 (file)
@@ -88,7 +88,7 @@ struct reverse_ilist_t
     int              numAtomsInMolecule; /* The number of atoms in this molecule */
 };
 
-/*! \brief Struct for thread local work data for local topology generation */
+/*! \internal \brief Struct for thread local work data for local topology generation */
 struct thread_work_t
 {
     /*! \brief Constructor
@@ -104,7 +104,7 @@ struct thread_work_t
     int                   excl_count = 0;        /**< The total exclusion count for \p excl */
 };
 
-/*! \brief Options for setting up gmx_reverse_top_t */
+/*! \internal \brief Options for setting up gmx_reverse_top_t */
 struct ReverseTopOptions
 {
     //! Constructor, constraints and settles are not including with a single argument
index 641c53d95ab44240e94a9c229e30a59445108f2a..0f85649b95813d0734cedc7ab27e367e53da1355 100644 (file)
@@ -62,7 +62,7 @@ class InteractionDefinitions;
 namespace gmx
 {
 
-//! Indices of atoms in a water molecule
+//! \internal \brief Indices of atoms in a water molecule
 struct WaterMolecule
 {
     //! Oxygen atom
index 804636f8f0e7600d322dff6e6cfc9f89fed1f767..893110f15b0e3d08993def2519a150f9c7f1bd97 100644 (file)
@@ -54,7 +54,7 @@ class GpuEventSynchronizer;
 namespace gmx
 {
 
-/*! \brief Scaling matrix struct.
+/*! \internal \brief Scaling matrix struct.
  *
  * \todo Should be generalized.
  */
index 0da8e1a69e4c8dbc5f5d61b23b9e2e31c9db7c2f..0dc0c23d789e30411e9aec8651015d93aca22e60 100644 (file)
@@ -91,10 +91,10 @@ struct OriresMatEq
     real mat[5][5]; /* The matrix                                 */
 };
 
-/* Orientation restraining stuff */
+//! \brief Orientation restraining stuff
 struct t_oriresdata
 {
-    /*! Constructor
+    /*! \brief Constructor
      *
      * \param[in] fplog  Log file, can be nullptr
      * \param[in] mtop   The global topology