Шаблон:Function template usage

Материал из CAMaaS preliminary wiki
Перейти к навигации Перейти к поиску

Набор шаблонов для детализированного описания метода класса C++:

Использование:

{{function begin|int Function(int parameter1, const void* input_buffer, void* output_buffer);|Краткое описание.}}
{{function paramlist begin}}
{{function paramlist add|parameter1|Описание параметра <tt>parameter1</tt>.}}
{{function paramlist add|input_buffer|Описание параметра <tt>input_buffer</tt>.|paramdir=[in]}}
{{function paramlist add|output_buffer|Описание параметра <tt>input_buffer</tt>.|paramdir=[out]}}
{{function paramlist end}}
{{function return_value|Описание возвращаемых значений}}
{{function details|Детализированное описание функции.}}
{{function end}}
int Function(int parameter1, const void* input_buffer, void* output_buffer);

Краткое описание.

Параметры
parameter1Описание параметра parameter1.
[in]input_bufferОписание параметра input_buffer.
[out]output_bufferОписание параметра output_buffer.
Возвращаемое значение:
Описание возвращаемых значений
Детализированное описание функции.