From b3b5ed6f0fa5b724602d042db900379db546fc06 Mon Sep 17 00:00:00 2001 From: Joe Jordan Date: Tue, 18 May 2021 10:50:09 +0000 Subject: [PATCH] Fix several doxygen errors --- src/gromacs/domdec/reversetopology.h | 4 ++-- src/gromacs/mdlib/settle_gpu.h | 2 +- src/gromacs/mdlib/update_constrain_gpu_internal.h | 2 +- src/gromacs/mdtypes/fcdata.h | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/gromacs/domdec/reversetopology.h b/src/gromacs/domdec/reversetopology.h index 62568fe6fa..0b9359b4b1 100644 --- a/src/gromacs/domdec/reversetopology.h +++ b/src/gromacs/domdec/reversetopology.h @@ -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 diff --git a/src/gromacs/mdlib/settle_gpu.h b/src/gromacs/mdlib/settle_gpu.h index 641c53d95a..0f85649b95 100644 --- a/src/gromacs/mdlib/settle_gpu.h +++ b/src/gromacs/mdlib/settle_gpu.h @@ -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 diff --git a/src/gromacs/mdlib/update_constrain_gpu_internal.h b/src/gromacs/mdlib/update_constrain_gpu_internal.h index 804636f8f0..893110f15b 100644 --- a/src/gromacs/mdlib/update_constrain_gpu_internal.h +++ b/src/gromacs/mdlib/update_constrain_gpu_internal.h @@ -54,7 +54,7 @@ class GpuEventSynchronizer; namespace gmx { -/*! \brief Scaling matrix struct. +/*! \internal \brief Scaling matrix struct. * * \todo Should be generalized. */ diff --git a/src/gromacs/mdtypes/fcdata.h b/src/gromacs/mdtypes/fcdata.h index 0da8e1a69e..0dc0c23d78 100644 --- a/src/gromacs/mdtypes/fcdata.h +++ b/src/gromacs/mdtypes/fcdata.h @@ -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 -- 2.22.0