Mercurial > hg > orthanc-python

annotate CodeAnalysis/PythonDocumentation.mustache @ 182:20b004998fc2 java-code-model

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documentation of custom methods
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 02 Jul 2024 14:06:56 +0200
parents faaa3fec799a
children 55473de7694f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
180
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 ##
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 ## Python plugin for Orthanc
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 ## Copyright (C) 2020-2023 Osimis S.A., Belgium
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 ## Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 ## Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 ##
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 ## This program is free software: you can redistribute it and/or
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 ## modify it under the terms of the GNU Affero General Public License
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 ## as published by the Free Software Foundation, either version 3 of
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 ## the License, or (at your option) any later version.
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 ##
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 ## This program is distributed in the hope that it will be useful, but
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 ## WITHOUT ANY WARRANTY; without even the implied warranty of
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 ## Affero General Public License for more details.
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 ##
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 ## You should have received a copy of the GNU Affero General Public License
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 ## along with this program. If not, see <http://www.gnu.org/licenses/>.
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 ##
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 import enum
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 {{#enumerations}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 class {{short_name}}(enum.Enum):
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 """
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 {{documentation}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 """
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 {{#values}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 """
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {{documentation}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 """
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {{key}}: int = {{value}},
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {{/values}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 {{/enumerations}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 {{#global_functions}}
181
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 180
diff changeset
40 {{> function_documentation}}
180
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 {{/global_functions}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {{#classes}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 class {{short_name}}:
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 ...
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 {{#methods}}
181
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 180
diff changeset
49 {{> function_documentation}}
180
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 {{/methods}}
182
20b004998fc2 documentation of custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 181
diff changeset
51
20b004998fc2 documentation of custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 181
diff changeset
52 {{#custom_methods}}
20b004998fc2 documentation of custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 181
diff changeset
53 {{> function_documentation}}
20b004998fc2 documentation of custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 181
diff changeset
54 {{/custom_methods}}
180
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 {{/classes}}