PLUTO
4.4-patch2
|
Documentation template for C source files. More...
#include "pluto.h"
Macros | |
#define | NEW_MACRO(a) (a+1) |
Functions | |
void | MyFunctionTemplate (int var) |
Variables | |
int | global_var |
Detailed description of the file goes here.
References
#define NEW_MACRO | ( | a | ) | (a+1) |
This is a comment for the following macro
void MyFunctionTemplate | ( | int | var | ) |
Start commenting the function here.
[in] | sweep | pointer to Sweep 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 Grid structure |
The following is an itemized list of HOWTO:
font
symbol (for multiple words use more than one word
).Indentation stops here.
To produce an enumerated list:
To produce code block just leave one blank line before and after and then indent like
FL -> swL*FL + swR*I(FR) FR -> swL*I(FL) + swR*FR
and come back.
To display a piece of code use
References
This is a buil-int comment
int global_var |
This is the description of global_var1