[gmx-developers] doxygen: public documentation, but is not in installed header

David van der Spoel spoel at xray.bmc.uu.se
Mon Apr 20 11:20:48 CEST 2015


using doxygen brings about a whole new level of debugging. In this case 
I have in the preamble of my code:

/*! \internal \file
  * \brief
  * Declares gmx::EnergyFrame
  * \author David van der Spoel <david.vanderspoel at icm.uu.se>
  * \ingroup module_energyanalysis

then I got the message in the subject which seems to complain I have 
*TOO MUCH* documentation, e.g.:

         //! The time in the simulation
         double      t_;
         //! Thw step in the simulation
         gmx_int64_t step_;
         //! The energy at this time point
         double      e_;

Any clue how to resolve this?
David van der Spoel, Ph.D., Professor of Biology
Dept. of Cell & Molec. Biol., Uppsala University.
Box 596, 75124 Uppsala, Sweden. Phone:	+46184714205.
spoel at xray.bmc.uu.se    http://folding.bmc.uu.se

More information about the gromacs.org_gmx-developers mailing list