Template Doxygen markup for DRMS modules
[Section 1. Programs, DRMS Modules, Shell Scripts]

A brief module description goes here. More...

Collaboration diagram for Template Doxygen markup for DRMS modules:
Synopsis:
   ModuleName [-bdfxGEN_FLAGS] in=<record-set query> out=<out series>
The first paragraph of an in-depth description goes here.

This is the second paragraph of the description

Flags:
-b: Some flag
-d: Another flag
-f: Yet another flag
-x: A fourth flag
GEN_FLAGS:
Ubiquitous flags present in every module. DRMS common main program
Parameters:
in A record-set query that identifies input records.
out The output series.
Exit_Status:
Brief description of abnormal, non-zero, exit values.
Example:
Brief description of the first example goes here
   ModuleName -bx in=<hmi.lev0> out=<hmi.lev03>
Example:
Brief description of the second example goes here
   ModuleName -f in=<hmi.lev0> out=<hmi.lev05>
Bug:
A description of any bugs goes here.
Code:
The doxygen code that makes this page is here:
/**
   @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;
}

Generated on Sat Jun 24 07:00:43 2017 for JSOC_Documentation by  doxygen 1.5.7.1