doxygen/examples/doxygen-example-module.cpp

   1 /*! \defgroup module_example "Example module (example)"
   2  * \ingroup group_utilitymodules
   3  * \brief
   4  * Brief description for the module.
   5  *
   6  * Detailed description of the module.  Can link to a separate Doxygen page for
   7  * overview, and/or describe the most important headers and/or classes in the
   8  * module as part of this documentation.
   9  *
  10  * For modules not exposed publicly, \\libinternal can be added at the
  11  * beginning (before \\defgroup).
  12  *
  13  * \author Author Name <author.name@email.com>
  14  */
  15
  16 // In other code, use \addtogroup module_example and \ingroup module_example to
  17 // add content (classes, functions, etc.) onto the module page.