Fix check source not parsing errors and warnings correctly

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

diff --git a/src/gromacs/selection/compiler.h b/src/gromacs/selection/compiler.h
index 6602835a7516411c8bf07bc195f1e1c332835825..97c9fb99f8a7f20c245446f0f96487f516f78d98 100644 (file)
--- a/src/gromacs/selection/compiler.h
+++ b/src/gromacs/selection/compiler.h
@@ -55,8 +55,19 @@ class SelectionCollection;
  * It prepares the selections in a selection collection for evaluation and
  * performs some optimizations.
  *
+ * Before compilation, the selection collection should have been initialized
+ * with gmx_ana_selcollection_parse_*().
+ * The compiled selection collection can be passed to
+ * gmx_ana_selcollection_evaluate() to evaluate the selection for a frame.
+ * If an error occurs, \p coll is cleared.
+ *
+ * The covered fraction information in \p coll is initialized to
+ * \ref CFRAC_NONE.
+ *
  * See \ref page_module_selection_compiler.
  *
+ * \param[in, out] coll Selection collection to work on.
+ *
  * \ingroup module_selection
  */
 void compileSelection(SelectionCollection* coll);