Шаблон:Function template usage: различия между версиями

Текущая версия на 21:30, 19 августа 2019

Набор шаблонов для детализированного описания функции:

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

{{function begin|template <class T>
int Function(int parameter1, const void* input_buffer, void* output_buffer, void* inout_buffer);|Краткое описание.}}
{{function template paramlist begin}}
{{function template paramlist add|T|Шаблонный параметр.}}
{{function template paramlist end}}
{{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>output_buffer</tt>.|paramdir=[out]}}
{{function paramlist add|inout_buffer|Описание параметра <tt>inout_buffer</tt>.|paramdir=[in, 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}}

template <class T>
int Function(int parameter1, const void* input_buffer, void* output_buffer, void* inout_buffer);

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

Параметры шаблона

T	Шаблонный параметр.

Параметры

	parameter1	Описание параметра `parameter1`.
[in]	input_buffer	Описание параметра `input_buffer`.
[out]	output_buffer	Описание параметра `output_buffer`.
[in, out]	inout_buffer	Описание параметра `inout_buffer`.

Возвращаемое значение:

Описание возвращаемых значений

Возможные исключения

std::exception

Описание исключения

См. также

Шаблон:Relation diagram usage

Диаграмма отношений

@@ Строка 1: / Строка 1: @@
-<noinclude>Набор шаблонов для детализированного описания метода класса C++:
+<noinclude>Набор шаблонов для детализированного описания функции:
 *[[Шаблон:function begin]]
+*[[Шаблон:function template paramlist begin]]
+*[[Шаблон:function template paramlist add]]
+*[[Шаблон:function template paramlist end]]
 *[[Шаблон:function paramlist begin]]
 *[[Шаблон:function paramlist add]]
@@ Строка 6: / Строка 9: @@
 *[[Шаблон: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]]
 </noinclude>Использование:
 <pre>
-{{function begin|int Add(int x, int y);|Краткое описание.}}
+{{function begin|template <class T>
+int Function(int parameter1, const void* input_buffer, void* output_buffer, void* inout_buffer);|Краткое описание.}}
+{{function template paramlist begin}}
+{{function template paramlist add|T|Шаблонный параметр.}}
+{{function template paramlist end}}
 {{function paramlist begin}}
-{{function paramlist add|x|Описание параметра <tt>x</tt>.}}
+{{function paramlist add|parameter1|Описание параметра <tt>parameter1</tt>.}}
-{{function paramlist add|y|Описание параметра <tt>y</tt>.}}
+{{function paramlist add|input_buffer|Описание параметра <tt>input_buffer</tt>.|paramdir=[in]}}
+{{function paramlist add|output_buffer|Описание параметра <tt>output_buffer</tt>.|paramdir=[out]}}
+{{function paramlist add|inout_buffer|Описание параметра <tt>inout_buffer</tt>.|paramdir=[in, 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}}
 </pre>
+{{function begin|template <class T>
-{{function begin|int Add(int x, int y);|Краткое описание.}}
+int Function(int parameter1, const void* input_buffer, void* output_buffer, void* inout_buffer);|Краткое описание.}}
+{{function template paramlist begin}}
+{{function template paramlist add|T|Шаблонный параметр.}}
+{{function template paramlist end}}
 {{function paramlist begin}}
-{{function paramlist add|x|Описание параметра <tt>x</tt>.}}
+{{function paramlist add|parameter1|Описание параметра <tt>parameter1</tt>.}}
-{{function paramlist add|y|Описание параметра <tt>y</tt>.}}
+{{function paramlist add|input_buffer|Описание параметра <tt>input_buffer</tt>.|paramdir=[in]}}
+{{function paramlist add|output_buffer|Описание параметра <tt>output_buffer</tt>.|paramdir=[out]}}
+{{function paramlist add|inout_buffer|Описание параметра <tt>inout_buffer</tt>.|paramdir=[in, 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}}

Шаблон:Function template usage: различия между версиями

Текущая версия на 21:30, 19 августа 2019

Навигация

Поиск