| \main | |
| This text will appear on the main page. | |
|
Example: \main Header for the main page Text for the main page which can go over multiple lines. |
| \author | |
| Author name | |
|
Example: \author Mihael Schmidt |
| \brief | |
| A brief description of one line of the program (required) | |
|
Example: \brief A brief description of the program |
| \date | |
| Date f. e. 28.04.2009 | |
|
Example: \date 28.04.2009 |
| \param | |
| Description of a Parameter | |
|
Example: \param Parameter description |
| \return | |
| Return value of a procedure (multiple lines supported) | |
|
Example: \return *on = success *off = error |
| \todo | |
| Description of an unfinished task | |
|
Example: \todo If you have a not yet finished task in this program or procedure you can add a todo tag and add the description of the task |
| \link | |
| A URL to a resource. The URLs must not contain spaces. Spaces can be replaced by %20. The description of the URL must be seperated from the URL by at least one space. | |
|
Example: \link http://iledocs.sourceforge.net ILEDocs Sourceforge.net project |
| \warning | |
| A warning for the user of the program/procedure. | |
|
Example: \warning The warning tag has similar syntax like the todo tag. |
| \info | |
| An informational tag for the reader. | |
|
Example: \info The info tag has similar syntax like the todo tag. |
| \rev | |
| With the revision tag changes at the program can be documented. On the first line after the revision tag the date of the change and the programmer should be stated. The date must not have a space. All following lines are the description of the program change. | |
|
Example: \rev 02.10.2006 Mihael Schmidt Program change which is covered by multiple lines of description. |
| \deprecated | |
| Deprecated: This program or procedure should be used any more. Typically a reason should be added after the tag and a solution/workaround (an alternative program/procedure). | |
|
Example: \deprecated This procedure has been replaced by procSQL. The data is now access via SQL. |
| \critical | |
| A tag for marking the program/procedure as critical. |
| \config | |
| Configuration data which is accessed by the program can be stated here. | |
|
Example: \config MAILSERVER IP-Address of the mail server |
/**
* \brief Documentation tool for RPG and CL programs
*
* Here is the main documentation for this program.
* Multiple lines of documentation are supported.
*
* The main documentation can also be seperated by one or more blank lines.
*
* <div><b>HTML tags</b> are allowed inside the documentation block
* and can be used to format the documentation for the specific output format (HTML).</div>
*
* \author Mihael Schmidt
* \date Mai 2006
*
* \todo Add more documentation here
* and in the wiki.
*
* \link http://www.stack.nl/~dimitri/doxygen/ Doxygen
*
* <div>This is also added to the description of the program. It does not have to be in one block.</div>
*
* \warning This program is very resource intensive.
*
* \info All files are access via SQL and
* don't have to be opened seperately.
*
* \rev 02.10.2006 Mihael Schmidt
* Data access changed from native to SQL (Task ERP000100XX)
*
* \critical
*
* \config MAILSERVER
* IP-Address of the mail server
* \param Item number
* \param Customer number
*/