diff -r d8fccb2cd802 -r 468f4c8d3d5b DITA-OT_CXX_Plugin/cxxapiref/doc/cxxFunction/cxxFunctionTemplateParameters.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/DITA-OT_CXX_Plugin/cxxapiref/doc/cxxFunction/cxxFunctionTemplateParameters.dita Wed Aug 11 14:49:30 2010 +0100 @@ -0,0 +1,47 @@ + + + + + cxxFunctionTemplateParameters + Collects together the template parameters for template functions. + +
+ Description

Collects together the template parameters for template functions.

See ISO/IEC 14882:2003(E) 14.1 Template parameters [temp.param]

+
+ + Example

Given this code:

+ /** + @tparam T The type of the first function object. + @tparam U The type of the second function object. + @return 1 on success, 0 on failure. + */ +template<typename T, typename U> +int templateFunction(T& x, U& y) +{ +} +

Then function templateFunction + would have the cxxFunctionTemplateParameters +element:

+ <cxxFunctionTemplateParameters> + <cxxFunctionTemplateParameter> + <cxxFunctionTemplateParameterType>typename T</cxxFunctionTemplateParameterType> + <apiDefNote>The type of the first function object. </apiDefNote> + </cxxFunctionTemplateParameter> + <cxxFunctionTemplateParameter> + <cxxFunctionTemplateParameterType>typename U</cxxFunctionTemplateParameterType> + <apiDefNote>The type of the second function object. </apiDefNote> + </cxxFunctionTemplateParameter> +</cxxFunctionTemplateParameters> +

If the mandatory attributes are present they must be set thus:

+ <cxxFunctionStorageClassSpecifierExtern name="extern" value="extern"/> + +
+
+
+
+
+ +