docs/doxygen/examples/doxygen-example.c

   1 /*! \file
   2  * \brief
   3  * Declares a collection of functions for performing a certain task.
   4  *
   5  * More details can go here.
   6  *
   7  * \author Example Author <example@author.com>
   8  * \inpublicapi
   9  * \ingroup module_mymodule
  10  */
  11
  12 /*! \addtogroup module_mymodule */
  13 /*! \{ */
  14
  15 /*! \brief
  16  * Brief description for the data structure.
  17  *
  18  * More details.
  19  *
  20  * \inpublicapi
  21  */
  22 typedef struct {
  23     /** Brief description for member. */
  24     int  member;
  25     int  second; /**< Brief description for the second member. */
  26     /*! \brief
  27      * Brief description for the third member.
  28      *
  29      * Details.
  30      */
  31     int  third;
  32 } gmx_mystruct_t;
  33
  34 /*! \brief
  35  * Performs a simple operation.
  36  *
  37  * \param[in] value  Input value.
  38  * \returns   Computed value.
  39  *
  40  * Detailed description.
  41  * \\inpublicapi cannot be used here, because Doxygen only allows a single
  42  * group for functions, and module_mymodule is the preferred group.
  43  */
  44 int gmx_function(int value);
  45
  46 /* Any . in the brief description should be escaped as \. */
  47 /** Brief description for this function. */
  48 int gmx_simple_function();
  49
  50 /*! \} */