Шаблон:Function template usage
Версия от 23:22, 30 декабря 2015; Андрей Чусов (обсуждение | вклад)
Набор шаблонов для детализированного описания метода класса C++:
- Шаблон:function begin
- Шаблон:function paramlist begin
- Шаблон:function paramlist add
- Шаблон:function paramlist end
- Шаблон:function return_value
- Шаблон:function details
- Шаблон:function end
Использование:
{{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. - Возвращаемое значение:
- Описание возвращаемых значений Детализированное описание функции.