doxy-comment.c File Reference

Documentation template for C source files. More...

Macros
#define	NEW_MACRO(a)   (a+1)

Functions
void	MyFunctionTemplate (void)

Variables
int	global_var1

Detailed Description

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

Date

Aug 16, 2012

Macro Definition Documentation

#define NEW_MACRO

(

a

)

(a+1)

This is a comment for the following macro

Function Documentation

void MyFunctionTemplate

(

void

)

Start commenting the function here.

Parameters

[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

• ".."
  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

Variable Documentation

int global_var1

This is the description of global_var1