sphinx-autoapi/autoapi/templates/dotnet/base_embed.rst

25 lines
531 B
ReStructuredText
Raw Normal View History

.. dn:{{ obj.ref_type }}:: {{ obj.name }}
{% if obj.summary %}
{% macro render() %}{{ summary }}{% endmacro %}
{{ render()|indent(4) }}
2015-04-14 02:10:19 +00:00
{% endif %}
{%- for param in obj.parameters %}
2015-04-14 02:10:19 +00:00
:param {{ param.name }}: {{ param.desc }}
2015-04-24 19:37:00 +00:00
{%- if param.type %}
2015-04-14 02:10:19 +00:00
:type {{ param.name }}: {{ param.type }}
2015-04-24 19:37:00 +00:00
{%- endif %}
2015-04-14 02:10:19 +00:00
{%- endfor %}
{%- if obj.returns %}
:rtype: {{ obj.returns.id }}
2015-04-15 07:10:50 +00:00
{%- endif %}
{%- if obj.example %}
2015-04-14 02:10:19 +00:00
.. code-block:: csharp
2015-04-24 19:37:00 +00:00
{{ obj.example }}
{%- endif %}