Шаблон:Method list template usage

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

Список методов задается шаблонами Шаблон:method_list begin, Шаблон:method_list add и Шаблон:method_list end. Также шаблонами Шаблон:method_list add ctor и Шаблон:method_list add dtor задаются соответственно конструкторы и деструкторы класса. Кроме того предварительно с помощью Шаблон:method_list_title может быть указан заголовок с опциональным указанием доступности, а также шаблоном Шаблон:method_list_subtitle - подзаголовок с произвольным текстом.

Пример:

{{method_list_title|access=public}}
{{method_list_begin}}
{{method_list_add|ExampleClass::Method1}}
{{method_list_add_ctor|ExampleClass}}
{{method_list_add_dtor|ExampleClass}}
{{method_list_end}}

{{method_list_title|access=protected}}
{{method_list_subtitle|Подзаголовок}}
{{method_list_begin}}
{{method_list_add|ExampleClass::Method2}}
{{method_list_add|ExampleClass::Method3|type=normal|Описание Method3.}}
{{method_list_add|ExampleClass::StaticMethod|type=static}}
{{method_list_end}}

{{method_list_title}}
{{method_list_begin}}
{{method_list_add|ExampleClass::Method4}}
{{method_list_end}}

{{method_list_begin}}
{{method_list_add|ExampleClass::Method5}}
{{method_list_end}}

{{method_list_begin}}
{{method_list_add_ctor|project/ExampleClass}}
{{method_list_add_dtor|project/ExampleClass}}
{{method_list_add|project/ExampleClass::Method5}}
{{method_list_end}}

Результат:

Открытые методы
МетодОписание
Method1Шаблон:ExampleClass::Method1 brief
(конструкторы)Шаблон:ExampleClass::ExampleClass brief
(деструктор)Шаблон:ExampleClass::~ExampleClass brief
Защищенные методы
Подзаголовок
МетодОписание
Method2Шаблон:ExampleClass::Method2 brief
Method3Описание Method3.
StaticMethodШаблон:ExampleClass::StaticMethod brief
Методы
МетодОписание
Method4Шаблон:ExampleClass::Method4 brief
МетодОписание
Method5Шаблон:ExampleClass::Method5 brief
МетодОписание
(конструкторы)Шаблон:Project/ExampleClass::ExampleClass brief
(деструктор)Шаблон:Project/ExampleClass::~ExampleClass brief
Method5Шаблон:Project/ExampleClass::Method5 brief

См. также: