Skip to content

Read the @nullable tag inside a parameter's own Doxygen entry - #211

Merged
estebanzimanyi merged 1 commit into
MobilityDB:masterfrom
estebanzimanyi:feat/nullable-tag-read
Oct 26, 2026
Merged

estebanzimanyi merged 1 commit into
MobilityDB:masterfrom
estebanzimanyi:feat/nullable-tag-read

Conversation

@estebanzimanyi

@estebanzimanyi estebanzimanyi commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

A MEOS parameter that accepts NULL is marked by the @nullable tag inside its own @PARAM entry, @param[in] newjb New value @nullable, so renaming the parameter edits the line that carries both. extract_nullable reads the tag anywhere in the entry's description, its continuation lines included, on an input and on an output a caller may pass as NULL to skip it, beside the prose note of the sources not yet converted to the tag. A line opening with @nullable ends the description before it and qualifies no parameter. extract_param_docs hands on the description without the tag.

Witness: tests/test_nullable.py reads the tag on an entry's line and on its continuation line behind an #if MEOS guard, reads the tag on an @PARAM[out], and reads no nullability from a line opening with @nullable. The catalog derived from MobilityDB master f3d480c80a, which carries no @nullable tag, is unchanged in every one of its 6721 functions. The 511 tests pass.

A MEOS parameter that accepts NULL is marked by the @nullable tag inside its own @PARAM entry, `@param[in] newjb New value @nullable`, so renaming the parameter edits the line that carries both. extract_nullable reads the tag anywhere in the entry's description, its continuation lines included, on an input and on an output a caller may pass as NULL to skip it, beside the prose note of the sources not yet converted to the tag. A line opening with @nullable ends the description before it and qualifies no parameter. extract_param_docs hands on the description without the tag.

Witness: tests/test_nullable.py reads the tag on an entry's line and on its continuation line behind an #if MEOS guard, reads the tag on an @PARAM[out], and reads no nullability from a line opening with @nullable. The catalog derived from MobilityDB master f3d480c80a, which carries no @nullable tag, is unchanged in every one of its 6721 functions. The 511 tests pass.
@estebanzimanyi
estebanzimanyi marked this pull request as ready for review October 26, 2026 15:34
@estebanzimanyi
estebanzimanyi merged commit 8479ce0 into MobilityDB:master Oct 26, 2026
3 checks passed
@estebanzimanyi
estebanzimanyi deleted the feat/nullable-tag-read branch October 26, 2026 15:37
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