view CodeAnalysis/FunctionDocumentation.mustache @ 194:0c5da632f34d java-code-model

added description of classes
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 02 Jul 2024 18:47:12 +0200
parents 7e8085f80df5
children 28531e615104
line wrap: on
line source

{{#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}}
    """
    ...