Classes

Extends: ude.interfaces.BaseParser

Abstract/base Doxygen XML parser managing common parsing steps and XML nodes retrieval.

Satisfies REQ-FUN-02, REQ-FUN-19, REQ-FUN-20

Class Variables

• ude.parsers.doxygen_base.BaseDoxygenParser._TAG_ALIAS_TYPE_RE

Instance Variables

• ude.parsers.doxygen_base.BaseDoxygenParser.exclude_swig_internals
• ude.parsers.doxygen_base.BaseDoxygenParser.export_macros
• ude.parsers.doxygen_base.BaseDoxygenParser.swig_fields
• ude.parsers.doxygen_base.BaseDoxygenParser.swig_methods
• ude.parsers.doxygen_base.BaseDoxygenParser.normalizer
• ude.parsers.doxygen_base.BaseDoxygenParser.name
• ude.parsers.doxygen_base.BaseDoxygenParser.nested_classes
• ude.parsers.doxygen_base.BaseDoxygenParser.language
• ude.parsers.doxygen_base.BaseDoxygenParser._docstring_format
• ude.parsers.doxygen_base.BaseDoxygenParser._dialect

Methods

init

__init__(self, exclude_swig_internals: bool, docstring_format: str, export_macros: Optional])

Initializes the BaseDoxygenParser with configuration flags.

docstring_format: Docstring dialect key ("auto", "plain", "numpy", "sphinx_rst").
export_macros: Compiler linkage/export macro names to strip from parsed
    names and signatures (see `strip_export_macros`). Each SDK tends to
    define its own (e.g. BimNv's `NWDBEXPORT`, FacetModeler's
    `FMGEOMETRY_API`) -- this is a per-project convention, not a generic
    one, so `None` keeps `strip_export_macros`'s own hardcoded default
    rather than silently applying one SDK's macros to another's.
**kwargs: Additional configuration parameters.

Satisfies REQ-FUN-02, REQ-FUN-20