Repository navigation
Read the MEOS Doxygen of pgtypes alike in every @param reader - #210
Merged
estebanzimanyi merged 1 commit intoOct 26, 2026
Merged
Conversation
The readers of the MEOS @PARAM Doxygen scan one list of sources, doxygen_sources: the src and include trees of meos/ and the sibling pgtypes/ tree, the vendored PostgreSQL base-type layer that defines public MEOS functions outside meos/ and documents them on its .c definitions. They also pair a Doxygen block with its function by one pattern, _FUNC, which steps over the preprocessor lines that separate the two where pgtypes/ guards the MEOS twin of a function with #if MEOS. extract_nullable and extract_param_docs read them as extract_param_names and extract_outparams do, so a parameter documented in pgtypes/ states its nullability to the catalog as its direction already does, on the function its block documents. Witness: the catalog derived from MobilityDB master f3d480c80a gains shape.nullable ["vars"] on jsonb_path_exists, jsonb_path_match, jsonb_path_query_array, jsonb_path_query_first and jsonb_path_query_all, whose @PARAM lines in pgtypes/utils/jsonpath_exec.c state that vars may be NULL above an #if MEOS guard; no other function of the 6721 changes, and shape.outParams is unchanged. The 509 tests pass.
estebanzimanyi
force-pushed
the
fix/pgtypes-doxygen-read
branch
from
October 26, 2026 14:17
1e51831 to
bddc6c1
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The readers of the MEOS @PARAM Doxygen scan one list of sources, doxygen_sources: the src and include trees of meos/ and the sibling pgtypes/ tree, the vendored PostgreSQL base-type layer that defines public MEOS functions outside meos/ and documents them on its .c definitions. They also pair a Doxygen block with its function by one pattern, _FUNC, which steps over the preprocessor lines that separate the two where pgtypes/ guards the MEOS twin of a function with #if MEOS. extract_nullable and extract_param_docs read them as extract_param_names and extract_outparams do, so a parameter documented in pgtypes/ states its nullability to the catalog as its direction already does, on the function its block documents.
Witness: the catalog derived from MobilityDB master f3d480c80a gains shape.nullable ["vars"] on jsonb_path_exists, jsonb_path_match, jsonb_path_query_array, jsonb_path_query_first and jsonb_path_query_all, whose @PARAM lines in pgtypes/utils/jsonpath_exec.c state that vars may be NULL above an #if MEOS guard; no other function of the 6721 changes, and shape.outParams is unchanged. The 509 tests pass.