Attach the doxygen module group (@ingroup) to the catalog#21
Open
estebanzimanyi wants to merge 2 commits into
Open
Attach the doxygen module group (@ingroup) to the catalog#21estebanzimanyi wants to merge 2 commits into
estebanzimanyi wants to merge 2 commits into
Conversation
Follow each function's @csqlfn -> wrapper @sqlfn -> SQL name chain and attach the resulting SQL name to the catalog. The vendored-source root is overridable via MDB_SRC_ROOT so the @sqlfn (and @InGroup) extraction can be pointed at the same pinned MobilityDB checkout as the headers, keeping the generated catalog reproducibly equivalent to that pin.
Parse the @InGroup meos_<group> tag from each MEOS-C function's source comment (meos/src) and attach it as a 'group' field on every catalog function. Those groups are the structure of the MEOS reference manual / doxygen XML (meos_setspan_accessor, meos_temporal_comp_ever, meos_geo_constructor, ...), so every catalog-driven binding can organize its generated surface the same way the manual does — a function is found in the same place across all tools. The meos_internal_* groups are carried through too, so a binding can filter the non-user-facing surface. 2155 user-facing functions across 175 groups.
estebanzimanyi
force-pushed
the
feat/catalog-doxygen-groups
branch
from
ef269a7 to
a9ee3ca
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
1 participant
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.
Stacked on #18 (reuses the
@sqlfnpass's vendored-source wiring) — review #18 first; the doxygroup commit is the top commit here.Parse the
@ingroup meos_<group>tag from each MEOS-C function's source comment (meos/src) and attach it as agroupfield on every catalog function. Those groups are the structure of the MEOS reference manual / doxygen XML (meos_setspan_accessor,meos_temporal_comp_ever,meos_geo_constructor, …), so every catalog-driven binding can organize its generated surface the same way the manual does — a function is found in the same place across all tools.The
meos_internal_*groups are carried through too, so a binding can filter the non-user-facing surface. Result at the latest pin: 2155 user-facing functions across 175 groups (561 internal). Mirrors the@sqlfnextractor's doxygen-block parsing.