Functions

List of functions in the ude.collectors.dom_ignore_filter namespace.

Entity Name	Description
_find_markers
transform	Converts DOM-IGNORE-BEGIN/END markers into Doxygen’s native , fail-open at both file and block level.
main	Doxygen INPUT_FILTER entry point: reads the file named in `sys.argv[1]`, applies `transform`, and writes the result to stdout, plus any diagnostics to stderr. This is what Doxygen actually invokes per file – see the module docstring for the INPUT_FILTER protocol.

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

_find_markers function

Returns every BEGIN/END marker occurrence as (start, end, kind), sorted by position (kind is "begin" or "end").

Methods

_find_markers

_find_markers(data: bytes)

Returns every BEGIN/END marker occurrence as (start, end, kind), sorted by position (kind is "begin" or "end").

Parameter	Type	Description
data	`bytes`

Generated with Flude

main function

Doxygen INPUT_FILTER entry point: reads the file named in sys.argv[1], applies transform, and writes the result to stdout, plus any diagnostics to stderr. This is what Doxygen actually invokes per file – see the module docstring for the INPUT_FILTER protocol.

Methods

main

main() -> int

transform function

Converts DOM-IGNORE-BEGIN/END markers into Doxygen’s native , fail-open at both file and block level.

Returns:

The transformed bytes, or data itself unchanged if no marker in it

Methods

transform

transform(data: bytes, diagnostics: Optional]) -> bytes

Converts DOM-IGNORE-BEGIN/END markers into Doxygen’s native , fail-open at both file and block level.

Returns:

The transformed bytes, or data itself unchanged if no marker in it

Parameter	Type	Description
data	`bytes`	Raw file bytes (never decoded – markers are pure ASCII, and
diagnostics	`Optional]`	Optional list to append human-readable strings to for

Generated with Flude