Read a parameter's NULL note through the markup around it - #135
Closed
estebanzimanyi wants to merge 1 commit into
Closed
Read a parameter's NULL note through the markup around it#135estebanzimanyi wants to merge 1 commit into
estebanzimanyi wants to merge 1 commit into
Conversation
Doxygen marks up the literal a description names, so one note is written four ways — `NULL`, ``NULL``, `@p NULL` and `\p NULL` — and the extractor reads only the bare and backticked pair. Eighteen parameters over sixteen functions carry a note an author marked up, and every one of them reaches the bindings as a parameter that must be supplied: the spheroid `interpolate_point4d_spheroid` takes the sphere path without, the measure of the nine `*_to_geomeas` walks, the cluster flag of `geo_union_dbscan`, and the identifier and distance a nearest-neighbour cursor step writes. `shape.nullable` carries 131 parameters over 102 functions, against 113 over 86, and no parameter loses the note it had. The suite states the markup forms beside the plain one, on a function whose third parameter carries no note at all.
Member
Author
|
Nullability derives from the SQL layer. PostgreSQL enforces STRICT at run time, so the declaration states the contract that a prose note only describes: 8201 of 8587 CREATE FUNCTION statements carry STRICT, 386 do not, and 154 PG_ARGISNULL guards name the arguments those admit, alongside 1136 parameters carrying a SQL DEFAULT. Reading five prose spellings of one note keeps prose as the source; what a generator reads is the SQL declaration and a tag beside the aliases doxygen/Doxyfile already defines. |
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.
Doxygen marks up the literal a description names, so one note is written four
ways —
NULL,NULL,@p NULLand\p NULL— and the extractor reads onlythe bare and backticked pair. Eighteen parameters over sixteen functions carry
a note an author marked up, and every one of them reaches the bindings as a
parameter that must be supplied: the spheroid
interpolate_point4d_spheroidtakes the sphere path without, the measure of the nine
*_to_geomeaswalks,the cluster flag of
geo_union_dbscan, and the identifier and distance anearest-neighbour cursor step writes.
shape.nullablecarries 131 parameters over 102 functions, against 113 over 86,and no parameter loses the note it had. The suite states the markup forms beside
the plain one, on a function whose third parameter carries no note at all.