include/mainpage.h

   1 /*! \file
   2  * \brief Dummy header for Doxygen documentation.
   3  *
   4  * This file just holds the main page for doxygen. When, at some point in the
   5  * future, there is an obvious location for this documentation, we should
   6  * move it there.
   7  */
   8
   9 /*! \mainpage Gromacs
  10
  11   GROMACS is a versatile package to perform molecular dynamics, i.e.  simulate
  12   the Newtonian equations of motion for systems with hundreds, to millions
  13   of particles.
  14
  15   Currently, there is documentation available (at least) on the following
  16   parts of the source tree:
  17    - \subpage thread_mpi
  18    - \subpage libtrajana
  19
  20   */
  21
  22