HELP - ParametersJavaStyle

Help

Example Code

HowToDocument

ParametersJavaStyle

Description Source Call Graph

HowToDocument::ParametersJavaStyle ( Public Method )

Author: N.F.S Grundtvig (The members of this class inherits the author by default.)

Parameter documentation - JavaDoc style.

Syntax / parameters

void ParametersJavaStyle (int iSize, HowToDocument &howToDocument, float fMAX2=2.1f)

Name	Type	Default	Description
iSize	int		Parameter documentation for iSize
howToDocument	HowToDocument &		Parameter documentation for howToDocument
fMAX2	float	2.1f	Parameter documentation for fMAX2

Description

Parameter documentation - JavaDoc style.
Here we can write all 3 parameters on the same line in the declaration, but the "price" is that we have to repeat the name of the parameter.

This is how it looks in the source:

\param iSize Parameter documentation for iSize
\param howToDocument Parameter documentation for howToDocument
\param fMAX2 Parameter documentation for fMAX2