Eql markdown fixes #151
Open
Eql markdown fixes #151
Conversation
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
Changed OPTIMIZE_OUTPUT_FOR_C from YES to NO in Doxyfile to enable C++ overloading support. SQL supports function overloading (like C++), but C does not. This setting allows Doxygen to better handle overloaded SQL functions, though a Doxygen limitation still causes the first overload in each group to be skipped during extraction. Related documentation: docs/api/markdown/PARSING_NOTES.md
Fixed multiple parsing issues in Doxygen XML to Markdown conversion: 1. Operator functions: Extract operator name from brief description when function name is schema-only (fixes `->>`, `->` showing as `eql_v2()`) 2. See Also links: Only create links for exact signature matches, keep as plain text if referenced function doesn't exist (prevents self-referencing when overload variants are missing) 3. SQL parameters: Swap <type> and <declname> elements since Doxygen parses SQL backwards (SQL: name type, C++: type name) 4. Schema-qualified types: Properly combine <ref> tail and <declname> for full type names like `eql_v2.ore_block_u64_8_256` Added test_xml_to_markdown.py to validate all parsing fixes. Documented in docs/api/markdown/PARSING_NOTES.md
Changed "See Also" section to "Variants" with cleaner formatting: 1. Renamed section from "See Also" to "Variants" - more accurately describes function overloads and is clearer for users 2. Strip schema prefix from variant references to match function title format: - Before: `eql_v2."->"(eql_v2_encrypted, text)` - After: `->(eql_v2_encrypted, text)` 3. Add "(not documented)" label for missing variants instead of keeping raw reference text Updated tests to reflect new terminology and behavior.
yujiyokoo
approved these changes
Nov 17, 2025
Contributor
yujiyokoo
left a comment
yujiyokoo
left a comment
There was a problem hiding this comment.
LGTM. I am not super-familiar with this or Python but looks good, and it's probably a good idea to check the actual output after merging rather than just the code.
Co-authored-by: Yuji Yokoo <[email protected]>
Contributor
Author
|
@yujiyokoo Good call on testing the actual output - was manually generated and inspected. |
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.
No description provided.