Functions

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

Entity Name	Description
parse_doxyfile	Parses raw Doxyfile text into a flat key/value mapping.
serialize_doxyfile	Serializes a key/value mapping back into valid Doxyfile syntax.
merge_doxyfile_tiers	Merges three Doxyfile configuration tiers into a single mapping.

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

Entity Name	Summary / Description
merge_doxyfile_tiers function	Merges three Doxyfile configuration tiers into a single mapping. T1 (global) is the base. T2 (local/custom) overrides T1. T3 (runtime) explicitly overrides T2. Any key-level override or collision is logged as a DEBUG entry under the “ude.collector.doxyfile” logger, naming the key. Returns: The merged key/value mapping. Methods merge_doxyfile_tiers `merge_doxyfile_tiers(t1: dict, t2: dict, t3: dict) -> dict` Merges three Doxyfile configuration tiers into a single mapping. T1 (global) is the base. T2 (local/custom) overrides T1. T3 (runtime) explicitly overrides T2. Any key-level override or collision is logged as a DEBUG entry under the “ude.collector.doxyfile” logger, naming the key.
parse_doxyfile function	Parses raw Doxyfile text into a flat key/value mapping. Skips blank lines and lines starting with ‘#’. Collapses Doxygen line continuations (lines ending with a trailing backslash) by space-joining the continued fragments into a single logical line before extracting the key/value pair. Keys are split strictly on the first ‘=’ sign. Duplicate keys (e.g. multi-value fields such as INPUT) accumulate as space-joined strings rather than overwriting the previous value. Returns:
serialize_doxyfile function	Serializes a key/value mapping back into valid Doxyfile syntax. Keys are sorted alphabetically and each entry is rendered as a single ‘KEY = VALUE’ line. The output ends with exactly one trailing newline. Returns: The serialized Doxyfile text, or an empty string when kvs is empty. Methods serialize_doxyfile `serialize_doxyfile(kvs: dict) -> str` Serializes a key/value mapping back into valid Doxyfile syntax. Keys are sorted alphabetically and each entry is rendered as a single ‘KEY = VALUE’ line. The output ends with exactly one trailing newline.

merge_doxyfile_tiers function

Merges three Doxyfile configuration tiers into a single mapping.

T1 (global) is the base. T2 (local/custom) overrides T1. T3 (runtime) explicitly overrides T2. Any key-level override or collision is logged as a DEBUG entry under the “ude.collector.doxyfile” logger, naming the key.

Returns:

The merged key/value mapping.

Methods

merge_doxyfile_tiers

merge_doxyfile_tiers(t1: dict, t2: dict, t3: dict) -> dict

Merges three Doxyfile configuration tiers into a single mapping.

parse_doxyfile function

Parses raw Doxyfile text into a flat key/value mapping.

Skips blank lines and lines starting with ‘#’. Collapses Doxygen line continuations (lines ending with a trailing backslash) by space-joining the continued fragments into a single logical line before extracting the key/value pair. Keys are split strictly on the first ‘=’ sign. Duplicate keys (e.g. multi-value fields such as INPUT) accumulate as space-joined strings rather than overwriting the previous value.

Returns:

serialize_doxyfile function

Serializes a key/value mapping back into valid Doxyfile syntax.

Keys are sorted alphabetically and each entry is rendered as a single ‘KEY = VALUE’ line. The output ends with exactly one trailing newline.

Returns:

The serialized Doxyfile text, or an empty string when kvs is empty.

Methods

serialize_doxyfile

serialize_doxyfile(kvs: dict) -> str

Serializes a key/value mapping back into valid Doxyfile syntax.

Keys are sorted alphabetically and each entry is rendered as a single ‘KEY = VALUE’ line. The output ends with exactly one trailing newline.