Шаблон:Function template usage
Версия от 01:05, 3 января 2016; Андрей Чусов (обсуждение | вклад)
Набор шаблонов для детализированного описания функции:
- Шаблон:function begin
- Шаблон:function paramlist begin
- Шаблон:function paramlist add
- Шаблон:function paramlist end
- Шаблон:function return_value
- Шаблон:function details
- Шаблон:function exceptionlist begin
- Шаблон:function exceptionlist add
- Шаблон:function exceptionlist end
- Шаблон:function sa begin
- Шаблон:function sa add
- Шаблон:function sa end
- Шаблон: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 exceptionlist begin}} {{function exceptionlist add|[http://en.cppreference.com/w/cpp/error/exception std::exception]|Описание исключения}} {{function exceptionlist end}} {{function sa begin}} {{function sa add|[[Шаблон:Relation diagram usage]]|Диаграмма отношений}} {{function sa end}} {{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. - Возвращаемое значение:
- Описание возвращаемых значений Детализированное описание функции.
- Возможные исключения
std::exception Описание исключения - См. также
Шаблон:Relation diagram usage Диаграмма отношений