gromacs cpp: clean up -Wunused-parameter warnings

[alexxy/gromacs.git] / src / gromacs / selection / evaluate.h

diff --git a/src/gromacs/selection/evaluate.h b/src/gromacs/selection/evaluate.h
index 8be9c9a1b4a45672316a5361d61abdca04b85779..ef904feb1dbcc69e0be29b8af4985e1764e63304 100644 (file)
--- a/src/gromacs/selection/evaluate.h
+++ b/src/gromacs/selection/evaluate.h
@@ -1,7 +1,7 @@
 /*
  * This file is part of the GROMACS molecular simulation package.
  *
- * Copyright (c) 2009,2010,2011,2012, by the GROMACS development team, led by
+ * Copyright (c) 2009,2010,2011,2012,2013, by the GROMACS development team, led by
  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
  * others, as listed in the AUTHORS file in the top-level source
  * directory and at http://www.gromacs.org.
@@ -97,12 +97,40 @@ _gmx_sel_evaluate_method_params(gmx_sel_evaluate_t                     *data,
 /*! \name Misc. evaluation functions
  */
 /*@{*/
-/** Evaluates a root selection element. */
+/*! \brief
+ * Evaluates a root selection element.
+ *
+ * \param[in] data Data for the current frame.
+ * \param[in] sel Selection element being evaluated.
+ * \param[in] g   Group for which \p sel should be evaluated
+ *   (not used, can be NULL).
+ * \returns   0 on success, a non-zero error code on error.
+ *
+ * Evaluates the first child element in the group defined by \p sel->u.cgrp.
+ * If \p sel->u.cgrp is empty, nothing is done.
+ * The value of \p sel is not touched (root elements do not evaluate to
+ * values).
+ *
+ * This function can be used as gmx::SelectionTreeElement::evaluate for
+ * \ref SEL_ROOT elements.
+ */
 void
 _gmx_sel_evaluate_root(gmx_sel_evaluate_t                     *data,
                        const gmx::SelectionTreeElementPointer &sel,
                        gmx_ana_index_t                        *g);
-/** Evaluates a static group selection element. */
+/*! \brief
+ * Evaluates a static group selection element.
+ *
+ * \param[in] data Data for the current frame.
+ * \param[in] sel Selection element being evaluated.
+ * \param[in] g   Group for which \p sel should be evaluated.
+ * \returns   0 for success.
+ *
+ * Sets the value of \p sel to the intersection of \p g and \p sel->u.cgrp.
+ *
+ * This function can be used as gmx::SelectionTreeElement::evaluate for
+ * \ref SEL_CONST elements with value type \ref GROUP_VALUE.
+ */
 void
 _gmx_sel_evaluate_static(gmx_sel_evaluate_t                     *data,
                          const gmx::SelectionTreeElementPointer &sel,