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

Instance Variables

• ude.parsers.doxygen_base.BaseDoxygenParser.exclude_swig_internals
• ude.parsers.doxygen_base.BaseDoxygenParser.exclude_pinvoke_bridge
• ude.parsers.doxygen_base.BaseDoxygenParser.export_macros
• ude.parsers.doxygen_base.BaseDoxygenParser.min_visibility
• dict ude.parsers.doxygen_base.BaseDoxygenParser.swig_fields
• dict ude.parsers.doxygen_base.BaseDoxygenParser.swig_methods
• dict ude.parsers.doxygen_base.BaseDoxygenParser.swig_wrapper_lifecycle_methods
• ude.parsers.doxygen_base.BaseDoxygenParser.normalizer
• Optional[str] ude.parsers.doxygen_base.BaseDoxygenParser.language
• ude.parsers.doxygen_base.BaseDoxygenParser.docstring
• ude.parsers.doxygen_base.BaseDoxygenParser.nested_classes
• str ude.parsers.doxygen_base.BaseDoxygenParser.entity_type
• ude.parsers.doxygen_base.BaseDoxygenParser.methods
• ude.parsers.doxygen_base.BaseDoxygenParser.fields
• ude.parsers.doxygen_base.BaseDoxygenParser.constants
• ude.parsers.doxygen_base.BaseDoxygenParser.enums
• ude.parsers.doxygen_base.BaseDoxygenParser.type_aliases
• str ude.parsers.doxygen_base.BaseDoxygenParser._docstring_format
• DocstringDialect ude.parsers.doxygen_base.BaseDoxygenParser._dialect

Methods

init

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

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. `LIBRARY_EXPORT`, `CORE_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.
min_visibility: One of `"public"`/`"protected"`/`"private"`, cascading
    (each level includes everything at or above it -- `"protected"`
    keeps public+protected, `"private"` keeps everything). Filters
    fields, methods (incl. constructors/destructors), enums, and
    nested-class references by their Doxygen `prot` attribute at the
    single point each is collected in `_parse_compound_file`, via the
    shared `_visible()` helper -- deliberately not four separate ad
    hoc checks, since that copy-paste pattern is exactly how a prior
    bug shipped (one member kind filtered, a sibling kind not).
    Default `"private"` (i.e. everything shown) is UNCHANGED engine
    behavior -- this is opt-in per the standing project rule that
    shared Doxygen-parser changes must default off. Confirmed
    2026-08-28 this is what real Docomatic output does for C++
    (`OdGiContextForNwDatabase::DatabaseHolder`, a private nested
    class, and `OdNwGeometry`'s two protected constructors are both
    fully absent from the real reference) -- scoped to the
    cpp/Doxygen path only this round; C#/Java/Python each model
    visibility differently (`internal`, package-private, no real
    enforcement) and are deliberately not addressed here.
**kwargs: Additional configuration parameters.

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