script:
- cd $BUILD_DIR
- cmake --build . --target check-source
- - grep -qi "error" docs/doxygen/doxygen*log docs/doxygen/check-source.log | tee doxygenError.txt || true
- - grep -qi "warning" docs/doxygen/doxygen*log docs/doxygen/check-source.log | tee -a doxygenError.txt || true
+ - awk '/warning.*include style.*order/,/You can use.*rst|^$/' docs/doxygen/check-source.log | tee doxygenError.txt || true
+ - awk '/Traceback/,/.*rror|^$/' docs/doxygen/doxygen*log docs/doxygen/check-source.log | tee -a doxygenError.txt || true
+ - awk '/warning:/,/in doxygen.*|^$/' docs/doxygen/doxygen*log | tee -a doxygenError.txt || true
- if [ -s doxygenError.txt ] ; then echo "Found errors while running doxygen"; exit 1; fi
artifacts:
name: docs-artifacts-$CI_COMMIT_REF_SLUG
#ifndef GMX_DOMDEC_DOMDEC_UTILITY_H
#define GMX_DOMDEC_DOMDEC_UTILITY_H
+#include "gromacs/math/vectypes.h"
#include "gromacs/mdtypes/forcerec.h"
#include "gromacs/utility/arrayref.h"
-#include "gromacs/math/vectypes.h"
#include "domdec_internal.h"
#include "gromacs/mdlib/stat.h"
#include "gromacs/mdrunutility/handlerestart.h"
#include "gromacs/mdrunutility/multisim.h"
+#include "gromacs/mdtypes/commrec.h"
#include "gromacs/mdtypes/enerdata.h"
#include "gromacs/mdtypes/imdmodule.h"
#include "gromacs/mdtypes/inputrec.h"
#include "gromacs/mdtypes/md_enums.h"
#include "gromacs/mdtypes/mdrunoptions.h"
-#include "gromacs/mdtypes/commrec.h"
#include "gromacs/mdtypes/state.h"
#include "gromacs/pbcutil/pbc.h"
#include "gromacs/timing/wallcycle.h"
namespace gmx
{
-/*!
- * \param[in,out] coll Selection collection to be compiled.
- *
- * 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 sc is cleared.
- *
- * The covered fraction information in \p sc is initialized to
- * \ref CFRAC_NONE.
- */
void compileSelection(SelectionCollection* coll)
{
gmx_ana_selcollection_t* sc = &coll->impl_->sc_;
* 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);
PrivateImplPointer<Impl> impl_;
- /*! \brief
- * Needed for the compiler to freely modify the collection.
- */
- friend void compileSelection(SelectionCollection* /*coll*/);
- /*! \brief
- * Needed for the evaluator to freely modify the collection.
- */
+ // Needed for the compiler to freely modify the collection.
+ friend void compileSelection(SelectionCollection* coll);
+ // Needed for the evaluator to freely modify the collection.
friend class SelectionEvaluator;
};