From 1333a483d730aed0633c63c782374c3ad6bb10c9 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vedran=20Mileti=C4=87?= Date: Tue, 20 Mar 2018 12:27:45 +0100 Subject: [PATCH] Document matrix_convert function in PBC The brief documentation was in place, but the documentation of the function parameters was missing. This patch adds it and also fixes incorrect Doxygen syntax at pbc_dx_d. Change-Id: Ic897911bf4b8866bb7c4dc3aea982493cc03874c --- src/gromacs/pbcutil/pbc.h | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/src/gromacs/pbcutil/pbc.h b/src/gromacs/pbcutil/pbc.h index bf5fd55529..41dbd883e4 100644 --- a/src/gromacs/pbcutil/pbc.h +++ b/src/gromacs/pbcutil/pbc.h @@ -3,7 +3,7 @@ * * Copyright (c) 1991-2000, University of Groningen, The Netherlands. * Copyright (c) 2001-2004, The GROMACS development team. - * Copyright (c) 2012,2014,2015,2016,2017, by the GROMACS development team, led by + * Copyright (c) 2012,2014,2015,2016,2017,2018, by the GROMACS development team, led by * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl, * and including many others, as listed in the AUTHORS file in the * top-level source directory and at http://www.gromacs.org. @@ -144,7 +144,12 @@ void dump_pbc(FILE *fp, t_pbc *pbc); */ const char *check_box(int ePBC, const matrix box); -/*! \brief Creates box matrix from edge lengths and angles. */ +/*! \brief Creates box matrix from edge lengths and angles. + * + * \param[inout] box The box matrix + * \param[in] vec The edge lengths + * \param[in] angleInDegrees The angles + */ void matrix_convert(matrix box, const rvec vec, const rvec angleInDegrees); /*! \brief Compute the maximum cutoff for the box @@ -241,7 +246,7 @@ void pbc_dx(const t_pbc *pbc, const rvec x1, const rvec x2, rvec dx); */ int pbc_dx_aiuc(const t_pbc *pbc, const rvec x1, const rvec x2, rvec dx); -/*\brief Compute distance with PBC +/*! \brief Compute distance with PBC * * As pbc_dx, but for double precision vectors. * set_pbc must be called before ever calling this routine. -- 2.11.4.GIT