Skip to content

Pair a Doxygen block with a definition whose signature a guard chooses - #223

Merged
estebanzimanyi merged 1 commit into
MobilityDB:masterfrom
estebanzimanyi:fix/doxygen-pairs-a-guarded-signature
Oct 31, 2026
Merged

estebanzimanyi merged 1 commit into
MobilityDB:masterfrom
estebanzimanyi:fix/doxygen-pairs-a-guarded-signature

Conversation

@estebanzimanyi

Copy link
Copy Markdown
Member

A guard may sit between the return-type line and the name of a definition,
choosing between two spellings of one signature, or inside its parameter
list. basetype_in in meos/src/temporal/type_in.c marks its end parameter
UNUSED in the build that does not read it, and skiplist_splice in
meos/src/temporal/skiplist.c its sktype parameter. The definition pattern
every @PARAM reader shares steps over the guard after the return type and
over the #else or #elif spellings and the closing #endif before the body,
and keeps the first spelling as the parameters.

On MobilityDB master 3c5baef2b3 the readers pair basetype_in and
skiplist_splice with their own blocks: basetype_in answers through its
result out parameter, parse_mfjson_coord and skiplist_values, which follow
them, keep their own blocks and document no parameter, and every other
function the readers derive is unchanged.

A guard may sit between the return-type line and the name of a definition,
choosing between two spellings of one signature, or inside its parameter
list. basetype_in in meos/src/temporal/type_in.c marks its end parameter
UNUSED in the build that does not read it, and skiplist_splice in
meos/src/temporal/skiplist.c its sktype parameter. The definition pattern
every @PARAM reader shares steps over the guard after the return type and
over the #else or #elif spellings and the closing #endif before the body,
and keeps the first spelling as the parameters.

On MobilityDB master 3c5baef2b3 the readers pair basetype_in and
skiplist_splice with their own blocks: basetype_in answers through its
result out parameter, parse_mfjson_coord and skiplist_values, which follow
them, keep their own blocks and document no parameter, and every other
function the readers derive is unchanged.
@estebanzimanyi
estebanzimanyi merged commit 1c9a7aa into MobilityDB:master Oct 31, 2026
3 checks passed
@estebanzimanyi
estebanzimanyi deleted the fix/doxygen-pairs-a-guarded-signature branch October 31, 2026 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant