(file) Return to doxygen_moduletemplate.txt CVS log (file) (dir) Up to [Development] / JSOC / doc / doxygen

File: [Development] / JSOC / doc / doxygen / doxygen_moduletemplate.txt (download)
Revision: 1.4, Fri Nov 14 05:52:43 2008 UTC (14 years, 6 months ago) by phil
Branch: MAIN
CVS Tags: Ver_LATEST, Ver_DRMSLATEST, Ver_9-5, Ver_9-41, Ver_9-4, Ver_9-3, Ver_9-2, Ver_9-1, Ver_9-0, Ver_8-8, Ver_8-7, Ver_8-6, Ver_8-5, Ver_8-4, Ver_8-3, Ver_8-2, Ver_8-12, Ver_8-11, Ver_8-10, Ver_8-1, Ver_8-0, Ver_7-1, Ver_7-0, Ver_6-4, Ver_6-3, Ver_6-2, Ver_6-1, Ver_6-0, Ver_5-9, Ver_5-8, Ver_5-7, Ver_5-6, Ver_5-5, Ver_5-3, Ver_5-2, Ver_5-14, Ver_5-13, Ver_5-12, Ver_5-11, Ver_5-10, Ver_5-1, Ver_5-0, NetDRMS_Ver_LATEST, NetDRMS_Ver_9-9, NetDRMS_Ver_9-5, NetDRMS_Ver_9-41, NetDRMS_Ver_9-4, NetDRMS_Ver_9-3, NetDRMS_Ver_9-2, NetDRMS_Ver_9-1, NetDRMS_Ver_9-0, NetDRMS_Ver_8-8, NetDRMS_Ver_8-7, NetDRMS_Ver_8-6, NetDRMS_Ver_8-5, NetDRMS_Ver_8-4, NetDRMS_Ver_8-3, NetDRMS_Ver_8-2, NetDRMS_Ver_8-12, NetDRMS_Ver_8-11, NetDRMS_Ver_8-10, NetDRMS_Ver_8-1, NetDRMS_Ver_8-0, NetDRMS_Ver_7-1, NetDRMS_Ver_7-0, NetDRMS_Ver_6-4, NetDRMS_Ver_6-3, NetDRMS_Ver_6-2, NetDRMS_Ver_6-1, NetDRMS_Ver_6-0, NetDRMS_Ver_2-7, NetDRMS_Ver_2-6, NetDRMS_Ver_2-5, NetDRMS_Ver_2-4, NetDRMS_Ver_2-3, NetDRMS_Ver_2-2, NetDRMS_Ver_2-1, NetDRMS_Ver_2-0b1, NetDRMS_Ver_2-0b, NetDRMS_Ver_2-0a2, NetDRMS_Ver_2-0a1, NetDRMS_Ver_2-0a, NetDRMS_Ver_2-0, HEAD
Changes since 1.3: +1 -1 lines
Add doxygen.css

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

   @brief A brief module description goes here

   @par 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

   @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
   ModuleName -bx in=<hmi.lev0> out=<hmi.lev03>

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

   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;

Karen Tian
Powered by
ViewCVS 0.9.4