linphone-ios/coreapi/help/doc/sphinx/class_page.mustache
2018-02-26 14:57:47 +01:00

161 lines
2.4 KiB
Text

{{#make_chapter}}{{{className}}} class{{/make_chapter}}
{{#isNotJava}}
.. {{#write_declarator}}class{{/write_declarator}}:: {{{fullClassName}}}
{{/isNotJava}}
{{#isJava}}
.. java:package:: {{{namespace}}}
.. java:type:: public interface {{{className}}};
{{/isJava}}
{{#briefDoc}}
{{#lines}}
{{{line}}}
{{/lines}}
{{/briefDoc}}
{{#detailedDoc}}
{{#lines}}
{{{line}}}
{{/lines}}
{{/detailedDoc}}
{{{selector}}}
Summary
=======
{{#hasProperties}}
Properties
----------
{{{propertiesSummary}}}
{{/hasProperties}}
{{#hasMethods}}
Methods
-------
{{{instanceMethodsSummary}}}
{{/hasMethods}}
{{#hasClassMethods}}
Class methods
-------------
{{{classMethodsSummary}}}
{{/hasClassMethods}}
Detailed descriptions
=====================
{{#hasProperties}}
Properties
----------
{{#properties}}
.. _{{{ref_label}}}:
{{{title}}}
{{#hasNamespaceDeclarator}}
.. {{#write_declarator}}namespace{{/write_declarator}}:: {{{fullClassName}}}
{{/hasNamespaceDeclarator}}
{{#getter}}
.. {{#write_declarator}}method{{/write_declarator}}:: {{{prototype}}}
{{#briefDoc}}
{{#lines}}
{{{line}}}
{{/lines}}
{{/briefDoc}}
{{#detailedDoc}}
{{#lines}}
{{{line}}}
{{/lines}}
{{/detailedDoc}}
{{{selector}}}
{{/getter}}
{{#setter}}
.. {{#write_declarator}}method{{/write_declarator}}:: {{{prototype}}}
{{#briefDoc}}
{{#lines}}
{{{line}}}
{{/lines}}
{{/briefDoc}}
{{#detailedDoc}}
{{#lines}}
{{{line}}}
{{/lines}}
{{/detailedDoc}}
{{{selector}}}
{{/setter}}
{{/properties}}
{{/hasProperties}}
{{#hasMethods}}
Public methods
--------------
{{#hasNamespaceDeclarator}}
.. {{#write_declarator}}namespace{{/write_declarator}}:: {{{fullClassName}}}
{{/hasNamespaceDeclarator}}
{{#methods}}
.. {{#write_declarator}}method{{/write_declarator}}:: {{{prototype}}}
{{#briefDoc}}
{{#lines}}
{{{line}}}
{{/lines}}
{{/briefDoc}}
{{#detailedDoc}}
{{#lines}}
{{{line}}}
{{/lines}}
{{/detailedDoc}}
{{{selector}}}
{{/methods}}
{{/hasMethods}}
{{#hasClassMethods}}
Class methods
-------------
{{#hasNamespaceDeclarator}}
.. {{#write_declarator}}namespace{{/write_declarator}}:: {{{fullClassName}}}
{{/hasNamespaceDeclarator}}
{{#classMethods}}
.. {{#write_declarator}}method{{/write_declarator}}:: static {{{prototype}}}
{{#briefDoc}}
{{#lines}}
{{{line}}}
{{/lines}}
{{/briefDoc}}
{{#detailedDoc}}
{{#lines}}
{{{line}}}
{{/lines}}
{{/detailedDoc}}
{{{selector}}}
{{/classMethods}}
{{/hasClassMethods}}