fml_doc_gen.func_dto

Classes

FunctionDTO

Data Transfer Object (DTO) for function metadata.

Module Contents

class fml_doc_gen.func_dto.FunctionDTO(name: str | None = '', output: str | None = None, inputs: List[Tuple[str, str]] | None = None, src: str | None = None)

Data Transfer Object (DTO) for function metadata.

name

The name of the function.

Type:

Optional[str]

output_type

The return type of the function.

Type:

Optional[str]

inputs

A list of input parameters as (name, type) tuples.

Type:

Optional[List[Tuple[str, str]]]

src

The source code or reference associated with the function.

Type:

Optional[str]

name = ''

output_type = None

inputs

src = None

__str__() → str

Returns a string representation of the FunctionDTO instance.

Returns:

A formatted string containing function name, return type, and inputs.

Return type:

str