PLUTO
Macros | Functions | Variables
doxy-comment.c File Reference

Documentation template for C source files. More...

#include "pluto.h"
Include dependency graph for doxy-comment.c:

Go to the source code of this file.

Macros

#define NEW_MACRO(a)   (a+1)
 

Functions

void MyFunctionTemplate (int var)
 

Variables

int global_var
 This is the description of global_var1. More...
 

Detailed Description

Documentation template for C source files.

Detailed description of the file goes here.

Authors
A. Mignone (migno.nosp@m.ne@p.nosp@m.h.uni.nosp@m.to.i.nosp@m.t)
C. Zanni (zanni.nosp@m.@oat.nosp@m.o.ina.nosp@m.f.it)
G. Muscianisi (g.mus.nosp@m.cian.nosp@m.isi@c.nosp@m.inec.nosp@m.a.it) P. Tzeferacos (petro.nosp@m.s.tz.nosp@m.efera.nosp@m.cos@.nosp@m.ph.un.nosp@m.ito..nosp@m.it) T. Matsakos

References

  • "PLUTO: A Numerical Code for Computational Astrophysics."
    Mignone et al, ApJS (2007) 170, 228
  • "The PLUTO Code for Adaptive Mesh Computations in Astrophysical Fluid Dynamics"
    Mignone et al, ApJS (2012) 198, 7M
  • "A conservative orbital advection scheme for simulations of magnetized shear flows with the PLUTO code"
    Mignone et al., A&A (2012) 545A, 152M
Date
Aug 20, 2015

Definition in file doxy-comment.c.

Macro Definition Documentation

#define NEW_MACRO (   a)    (a+1)

This is a comment for the following macro

Definition at line 30 of file doxy-comment.c.

Function Documentation

void MyFunctionTemplate ( int  var)

Start commenting the function here.

Parameters
[in]statepointer to State_1D structure
[in]beginitial index of computation
[in]endfinal index of computation
[in,out]dpointer to PLUTO Data structure
[out]src2D array of source terms
[in]gridpointer to an array of Grid structures

The following is an itemized list of HOWTO:

  • Display an extended math formula:

    \[ A\cos\phi = B\exp\left(\frac{y}{q}\right) \]

    while in the text simply use $ x^2-y^2 = 0$.
  • To display something in bold use bold symbol.
  • To display something in typewrite use font symbol (for multiple words use more than one word).
  • To emphasize text use text or text or, alternatively, text (for multiple words more than one word ).
  • To reference to a global variable use global_var.
  • To reference to a function use just, e.g., Boundary().

Indentation stops here.
To produce an enumerated list:

  1. first item
  2. second item
  3. etc...

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

1 restart;
2 a := b;
3 c := d-e;

References

  • ".."
    Mignone et al, JCP (2010) xx, xx
Returns
This function has no return value.
See also
Attention
Note
–
Todo:
–

This is a buil-int comment

Definition at line 35 of file doxy-comment.c.

97 {
98 
99 /* ---------------------------------------------------------------- */
100 /*! This is a buil-int comment */
101 /* ---------------------------------------------------------------- */
102 
103 }

Variable Documentation

int global_var

This is the description of global_var1.

Definition at line 32 of file doxy-comment.c.