PLUTO
doxy-comment.c
Go to the documentation of this file.
1 /* ///////////////////////////////////////////////////////////////////// */
2 /*!
3  \file
4  \brief Documentation template for C source files.
5 
6  Detailed description of the file goes here.
7 
8  \authors A. Mignone (mignone@ph.unito.it)\n
9  C. Zanni (zanni@oato.inaf.it)\n
10  G. Muscianisi (g.muscianisi@cineca.it)
11  P. Tzeferacos (petros.tzeferacos@ph.unito.it)
12  T. Matsakos
13 
14  \b References
15  - "PLUTO: A Numerical Code for Computational Astrophysics." \n
16  Mignone et al, ApJS (2007) 170, 228
17  - "The PLUTO Code for Adaptive Mesh Computations in Astrophysical Fluid
18  Dynamics" \n
19  Mignone et al, ApJS (2012) 198, 7M
20  - "A conservative orbital advection scheme for simulations of magnetized
21  shear flows with the PLUTO code"\n
22  Mignone et al., A\&A (2012) 545A, 152M
23 
24  \date Aug 20, 2015
25 */
26 /* ///////////////////////////////////////////////////////////////////// */
27 #include"pluto.h"
28 
29 /*! This is a comment for the following macro */
30 #define NEW_MACRO(a) (a+1)
31 
32 int global_var; /**< This is the description of global_var1 */
33 
34 /* ********************************************************************* */
35 void MyFunctionTemplate (int var)
36 /*!
37  * Start commenting the function here.
38  *
39  * \param [in] state pointer to State_1D structure
40  * \param [in] beg initial index of computation
41  * \param [in] end final index of computation
42  * \param [in,out] d pointer to PLUTO Data structure
43  * \param [out] src 2D array of source terms
44  * \param [in] grid pointer to an array of Grid structures
45  *
46  * The following is an itemized list of HOWTO:\n
47  * - Display an extended math formula:
48  * \f[
49  * A\cos\phi = B\exp\left(\frac{y}{q}\right)
50  * \f]
51  * while in the text simply use \f$ x^2-y^2 = 0\f$.
52  * - To display something in bold use \b bold symbol.
53  * - To display something in typewrite use \c font symbol
54  * (for multiple words use <tt>more than one word</tt>).
55  * - To emphasize text use *text* or **text** or, alternatively,
56  * \e text (for multiple words <em> more than one word </em>).
57  * - To reference to a global variable use ::global_var.
58  * - To reference to a function use just, e.g., Boundary().
59  *
60  * Indentation stops here. \n
61  *
62  * To produce an enumerated list:
63  *
64  * -# first item
65  * -# second item
66  * -# etc...
67  *
68  *
69  * To produce code block just leave one blank line before and after and
70  * then indent like
71  *
72  * FL -> swL*FL + swR*I(FR)
73  * FR -> swL*I(FL) + swR*FR
74  *
75  * and come back.
76  *
77  * To display a piece of code use
78  * \code
79  * restart;
80  * a := b;
81  * c := d-e;
82  * \endcode
83  *
84  *
85  *
86  * \b References
87  * - ".." \n
88  * Mignone et al, JCP (2010) xx, xx
89  *
90  * \return This function has no return value.
91  * \see
92  * \attention
93  * \note --
94  * \todo --
95  *
96  *********************************************************************** */
97 {
98 
99 /* ---------------------------------------------------------------- */
100 /*! This is a buil-int comment */
101 /* ---------------------------------------------------------------- */
102 
103 }
104 
105 
106 /* ********************************************************************* */
107 /*! Structure comment here
108  ********************************************************************* */
global_var
int global_var
This is the description of global_var1.
Definition: doxy-comment.c:32
MyFunctionTemplate
void MyFunctionTemplate(int var)
Definition: doxy-comment.c:35
pluto.h
PLUTO main header file.