view CodeAnalysis/FunctionDocumentation.mustache @ 203:28531e615104

documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 03 Jul 2024 12:03:09 +0200
parents 7e8085f80df5
children d7acfccc0d0b
line wrap: on
line source

{{#args}}{{#callable_protocol_return}}
class {{callable_type}}(typing.Protocol):
    def __call__(self, {{callable_protocol_args}}) -> {{callable_protocol_return}}:
        ...
{{/callable_protocol_return}}{{/args}}
{{#documentation.short_description}}
# {{documentation.short_description}}
{{/documentation.short_description}}
def {{short_name}}({{#self}}self{{#documentation.has_args}}, {{/documentation.has_args}}{{/self}}{{documentation.args_declaration}}) -> {{documentation.return_type}}:
    """
{{#documentation.description}}
    {{text}}
{{/documentation.description}}
{{#documentation.has_args}}

    Args:
      {{#documentation.args}}
      {{name}} ({{type}}): {{text}}
      {{/documentation.args}}
{{/documentation.has_args}}
{{#documentation.has_return}}

    Returns:
      {{documentation.return_type}}: {{documentation.return_text}}
{{/documentation.has_return}}
    """
    ...