src/gromacs/selection/selhelp.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Functions for initializing online help for selections.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_selection
  37  */
  38 #ifndef GMX_SELECTION_SELHELP_H
  39 #define GMX_SELECTION_SELHELP_H
  40
  41 #include "../onlinehelp/helptopicinterface.h"
  42
  43 namespace gmx
  44 {
  45
  46 /*! \cond internal */
  47 /*! \internal \brief
  48  * Creates a help tree for selections.
  49  *
  50  * \throws   std::bad_alloc if out of memory.
  51  * \returns  Root topic of the created selection tree.
  52  *
  53  * \ingroup module_selection
  54  */
  55 HelpTopicPointer createSelectionHelpTopic();
  56 //! \endcond
  57
  58 } // namespace gmx
  59
  60 #endif