HELP - ParameterDocCombined < T, COUNT >
HelpExample CodeHowToDocumentParameterDocCombined<>
Description Source Call Graph
HowToDocument::ParameterDocCombined<> ( Public Inline Method Template General )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
Combining the ways to doc parameters for the template.
 
Template syntax / parameters
ParameterDocCombined < T, COUNT >

Name Type Default Description
T class
  Description of a template parameter. Remember: Template parameters must be described using \param keyword.
COUNT int
  One more template parameter
Syntax / parameters
int ParameterDocCombined(int iSize, HowToDocument &howToDocument, float fMAX2=2.1f)

Name Type Default Description
iSize int
  Parameter documentation for iSize
howToDocument HowToDocument &
  Parameter documentation for TestDocBent
fMAX2 float
2.1f Parameter documentation for fMAX2
 
Return value int
  This is the return doc.
Description
Combining the ways to doc parameters for the template.

This is how it looks in the source:
\param T Description of a template parameter. #Remember:# Template parameters
{must{ be described using $\\param$ keyword.
\param COUNT One more template parameter
\return This is the return doc. 
template <class T, int COUNT = 5 >  
int                 ParameterDocCombined( int iSize,                    ///< Parameter documentation for iSize
                                          HowToDocument& howToDocument, ///< Parameter documentation for TestDocBent
                                          float fMAX2 = 2.1f            ///< Parameter documentation for fMAX2
                                         )
{}



 
Source
The documentation for this Member was generated from the following file:
  • HowtoDocument.h