<%namespace name="doc" file="_doc.tmpl"/>
<%def name="describe_parameters(m, static=False, virtual=False)">
% if static:
- Type:
- Static
% elif virtual:
- Type:
- Virtual
% endif
<%
in_params = formatter.get_in_parameters(m)
out_params = formatter.get_out_parameters(m)
%>
% if in_params or isinstance(m, ast.Signal):
- Parameters:
-
% if isinstance(m, ast.Signal):
-
${formatter.to_lower_camel_case(m.parent.name)}
(
${m.parent.gi_name})
— the emitting object
%endif
% for p in in_params:
-
${p.argname}
(
${formatter.format_type(p.type)})
% if p.doc:
— ${formatter.format_inline(m, p.doc)}
% endif
% endfor
% endif
% if out_params:
- Returns:
-
% for p in out_params:
-
% if len(out_params) > 1:
${p.argname}
% endif
(
${formatter.format_type(p.type)})
% if p.doc:
— ${formatter.format_inline(m, p.doc)}
% endif
% endfor
% endif
% if m.throws:
- Throws exception:
- Yes
% endif
<%def name="method(m, static=False, virtual=False)">
<%doc:introspectable node="${m}">
<% invocation = ", ".join(map(lambda p: p.argname, m.parameters)) %>
${formatter.format_function_name(m)}(${formatter.format_in_parameters(m)})
${describe_parameters(m, static, virtual)}
${doc.format_documentation(m)}