Overview docs for analysis nbsearch

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

diff --git a/src/gromacs/selection/nbsearch.h b/src/gromacs/selection/nbsearch.h
index d5ae8d41c417f126324520bb99a70ae683d903dc..062d9b025833f94ab30b415013077f2f4ce28edf 100644 (file)
--- a/src/gromacs/selection/nbsearch.h
+++ b/src/gromacs/selection/nbsearch.h
@@ -36,11 +36,10 @@
  * \brief API for neighborhood searching for analysis.
  *
  * The main part of the API is the class gmx::AnalysisNeighborhood.
- * See the class documentation for usage.
+ * See \ref page_analysisnbsearch for an overview.
  *
  * The classes within this file can be used independently of the other parts
- * of the library.
- * The library also uses the classes internally.
+ * of the selection module.
  *
  * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \inpublicapi
@@ -196,11 +195,7 @@ class AnalysisNeighborhoodPositions
 /*! \brief
  * Neighborhood searching for analysis tools.
  *
- * This class implements neighborhood searching routines for analysis tools.
- * The emphasis is in flexibility and ease of use; one main driver is to have
- * a common implementation of grid-based searching to avoid replicating this in
- * multiple tools (and to make more tools take advantage of the significant
- * performance improvement this allows).
+ * See \ref page_analysisnbsearch for an overview.
  *
  * To use the search, create an object of this type, call setCutoff() to
  * initialize it, and then repeatedly call initSearch() to start a search with