Mercurial > hg > orthanc-python

annotate CodeAnalysis/FunctionDocumentation.mustache @ 181:faaa3fec799a java-code-model

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
refactoring using FunctionDocumentation.mustache
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 02 Jul 2024 13:26:33 +0200
parents
children 7e8085f80df5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
181
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 {{#documentation.short_description}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 # {{documentation.short_description}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 {{/documentation.short_description}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 def {{short_name}}({{#is_method}}self{{#documentation.has_args}}, {{/documentation.has_args}}{{/is_method}}{{documentation.args_declaration}}) -> {{documentation.return_type}}:
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 """
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 {{#documentation.description}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 {{text}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 {{/documentation.description}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 {{#documentation.has_args}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 Args:
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 {{#documentation.args}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 {{name}} ({{type}}): {{text}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 {{/documentation.args}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 {{/documentation.has_args}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 {{#documentation.has_return}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 Returns:
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 {{documentation.return_type}}: {{documentation.return_text}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 {{/documentation.has_return}}
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 """
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 ...