method_doc.py

class MethodDoc():
    def __init__(self, namespace, method_sig):
        self.__namespace = namespace
        self.__method_sig = method_sig
        self.__description = ''
        self.__signature = ''
        self.__parameters = {}
        self.__return_type = ''
        self.__return_description = ''
        self.__errors = {}
        self.__example = ''
        self.__remarks = ''

    def set_description(self, value):
        self.__description = value

    def set_signature(self, value):
        self.__signature = value

    def set_example(self, value):
        self.__example = value

    def set_remarks(self, value):
        self.__remarks = value

    def get_namespace(self):
        return self.__namespace

    def get_method_sig(self):
        return self.__method_sig

    def build(self):
        output = ''
        output = f'# {self.__namespace}.{self.__method_sig} Method\n\n'

        if self.__description:
            output += f'{self.__description}\n\n'

        if self.__signature:
            output += f'```vb\n{self.__signature}\n```\n\n'

        if self.__parameters:
            output += '### Parameters\n\n'
            for name in self.__parameters:
                output += f'**{name}** `{self.__parameters[name][0]}` <br>\n'
                output += f'{self.__parameters[name][1]}\n\n'

        if self.__return_type:
            output += '### Returns\n\n'
            output += f'`{self.__return_type}` <br>\n'
            output += f'{self.__return_description}\n\n'

        if self.__errors:
            output += '### Errors\n\n'
            for err in self.__errors:
                descriptions = self.__errors[err]
                desc = descriptions.pop(0)
                output += f'`{err}` <br>\n{desc}\n\n'

                # If there are multiple descriptions for a particular error
                # here, attach them to the document with -or- separator.
                for desc in descriptions:
                    output += f'-or-\n\n{desc}\n\n'

        if self.__example:
            output += f'## Examples\n\n{self.__example}\n\n'

        if self.__remarks:
            output += f'### Remarks\n\n{self.__remarks}\n'

        return output

    def add_parameter(self, name, param_type, description):
        self.__parameters.update({name: [param_type, description]})

    def add_returns(self, param_type, description):
        self.__return_type = param_type
        self.__return_description = description

    def add_error(self, name, description):
        if (name in self.__errors):
            self.__errors[name].append(description)
        else:
            self.__errors.update({name: [description]})