Documentation template for C source files. More...
Macros | |
| #define | NEW_MACRO(a) (a+1) |
Functions | |
| void | MyFunctionTemplate (void) |
Variables | |
| int | global_var1 |
Detailed description of the file goes here.
| #define NEW_MACRO | ( | a | ) | (a+1) |
This is a comment for the following macro
| void MyFunctionTemplate | ( | void | ) |
Start commenting the function here.
| [in] | state | pointer to State_1D structure |
| [in] | beg | initial index of computation |
| [in] | end | final index of computation |
| [in,out] | d | pointer to PLUTO Data structure |
| [out] | src | 2D array of source terms |
| [in] | grid | pointer to an array of Grid structures |
References
This is a buil-int comment
| int global_var1 |
This is the description of global_var1
1.8.2