Mercurial > hg > orthanc-python

annotate CodeAnalysis/PythonDocumentation.mustache @ 227:9574f06d8588 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
todo
author Alain Mazy <am@orthanc.team>
date Tue, 24 Sep 2024 08:54:11 +0200
parents 9363da60c3c3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
219
3678a028f1f6 making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
1 # SPDX-FileCopyrightText: 2020-2023 Osimis S.A., 2024-2024 Orthanc Team SRL, 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain
3678a028f1f6 making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
2 # SPDX-License-Identifier: AGPL-3.0-or-later
3678a028f1f6 making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 194
diff changeset
3
180
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 ##
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 ## Python plugin for Orthanc
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 ## 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
7 ## 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
8 ## 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
9 ##
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 ## 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
11 ## 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
12 ## 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
13 ## 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
14 ##
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 ## 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
16 ## 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
17 ## 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
18 ## Affero General Public License for more details.
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 ## 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
21 ## 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
22 ##
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
186
55473de7694f added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 182
diff changeset
24
55473de7694f added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 182
diff changeset
25 # WARNING: Auto-generated file. Do not modify it by hand.
55473de7694f added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 182
diff changeset
26
55473de7694f added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 182
diff changeset
27
192
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 186
diff changeset
28 import typing
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 186
diff changeset
29
180
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 {{#enumerations}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
223
9363da60c3c3 in "orthanc.pyi", enumerations are not tagged as deriving from "enum.Enum" anymore
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 219
diff changeset
33 class {{short_name}}():
180
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 """
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {{documentation}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 """
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 {{#values}}
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 """
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 {{documentation}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 """
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {{key}}: int = {{value}},
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 {{/values}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {{/enumerations}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
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 {{#global_functions}}
181
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 180
diff changeset
48 {{> function_documentation}}
180
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 {{/global_functions}}
192
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 186
diff changeset
50 {{#custom_functions}}
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 186
diff changeset
51 {{> function_documentation}}
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 186
diff changeset
52 {{/custom_functions}}
180
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 {{#classes}}
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 class {{short_name}}:
194
0c5da632f34d added description of classes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
57 """
0c5da632f34d added description of classes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
58 {{description}}
0c5da632f34d added description of classes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
59 """
180
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 ...
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 {{#methods}}
181
faaa3fec799a refactoring using FunctionDocumentation.mustache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 180
diff changeset
63 {{> function_documentation}}
180
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 {{/methods}}
182
20b004998fc2 documentation of custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 181
diff changeset
65
20b004998fc2 documentation of custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 181
diff changeset
66 {{#custom_methods}}
20b004998fc2 documentation of custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 181
diff changeset
67 {{> function_documentation}}
20b004998fc2 documentation of custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 181
diff changeset
68 {{/custom_methods}}
180
ddf3e987827f created Python documentation for the Orthanc interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 {{/classes}}