view CodeAnalysis/PythonDocumentation.mustache @ 220:7ecdfdcb49d5

NEWS
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 04 Jul 2024 08:32:24 +0200
parents 3678a028f1f6
children 9363da60c3c3
line wrap: on
line source

# SPDX-FileCopyrightText: 2020-2023 Osimis S.A., 2024-2024 Orthanc Team SRL, 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain
# SPDX-License-Identifier: AGPL-3.0-or-later

##
## Python plugin for Orthanc
## Copyright (C) 2020-2023 Osimis S.A., Belgium
## Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
## Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
##
## This program is free software: you can redistribute it and/or
## modify it under the terms of the GNU Affero General Public License
## as published by the Free Software Foundation, either version 3 of
## the License, or (at your option) any later version.
##
## This program is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## Affero General Public License for more details.
##
## You should have received a copy of the GNU Affero General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>.
##


# WARNING: Auto-generated file. Do not modify it by hand.


import enum
import typing


{{#enumerations}}

class {{short_name}}(enum.Enum):
    """
    {{documentation}}
    """
{{#values}}

    """
    {{documentation}}
    """
    {{key}}: int = {{value}},
{{/values}}
{{/enumerations}}


{{#global_functions}}
{{> function_documentation}}
{{/global_functions}}
{{#custom_functions}}
{{> function_documentation}}
{{/custom_functions}}


{{#classes}}
class {{short_name}}:
    """
    {{description}}
    """
    ...

{{#methods}}
    {{> function_documentation}}
{{/methods}}

{{#custom_methods}}
    {{> function_documentation}}
{{/custom_methods}}
{{/classes}}