Return to doxygen_moduletemplate.txt CVS log

Up to [Development] / JSOC / doc / doxygen

Add doxygen.css

/**
   @defgroup module_template Template Doxygen markup for DRMS modules
   @ingroup a_programs

   @brief A brief module description goes here

   @par Synopsis:
   @code
   ModuleName [-bdfxGEN_FLAGS] in=<record-set query> out=<out series>
   @endcode

   The first paragraph of an in-depth description goes here.

   This is the second paragraph of the description

   @par Flags:
   @c -b: Some flag <br>
   @c -d: Another flag <br>
   @c -f: Yet another flag <br>
   @c -x: A fourth flag <br>

   @par GEN_FLAGS:
   Ubiquitous flags present in every module.
   @ref jsoc_main

   @param in A record-set query that identifies input records.
   @param out The output series.

   @par Exit_Status:
   Brief description of abnormal, non-zero, exit values.

   @par Example:
   Brief description of the first example goes here
   @code
   ModuleName -bx in=<hmi.lev0> out=<hmi.lev03>
   @endcode

   @par Example:
   Brief description of the second example goes here
   @code
   ModuleName -f in=<hmi.lev0> out=<hmi.lev05>
   @endcode

   @bug
   A description of any bugs goes here.

   @par Code:
   The doxygen code that makes this page is here:
   @verbinclude  ./doxygen_moduletemplate.txt
*/

// From here on proceed with module code.
// ....
// ....

int DoIt(void)
{
        return 0;
}