doxygen/examples/doxygen-example-issues.cpp

   1 // The struct itself is not documented; other comments within the declaration
   2 // are ignored.
   3
   4 struct t_struct {
   5
   6     // The comment tries to document both members at once, but it only
   7     // applies to the first.  The second produces warnings about missing
   8     // documentation (if the enclosing struct was documented).
   9
  10     //! Angle parameters.
  11     double alpha, beta;
  12 };
  13
  14
  15 // This does not produce any brief documentation.
  16 // An explicit \brief is required, or //! (C++) or /** */ (C) should be used.
  17
  18 /*! Brief comment. */
  19 int gmx_function();
  20
  21
  22 // This does not produce any documentation at all, since a ! is missing at
  23 // the beginning.
  24
  25 /* \brief
  26  * Brief description.
  27  *
  28  * More details.
  29  */
  30 int gmx_function();
  31
  32
  33 // This puts the whole paragraph into the brief description.
  34 // A short description is preferable, separated by an empty line from the rest
  35 // of the text.
  36
  37 /*! \brief
  38  * Brief description. The description continues with all kinds of details about
  39  * what the function does and how it should be called.
  40  */
  41 int gmx_function();