Add API documentation to README#67
Merged
duncdrum merged 1 commit intoeXist-db:masterfrom Feb 21, 2026
Merged
Conversation
Add an "API Documentation" section to the README with full xqDoc coverage of all variables and functions in semver.xqm, generated using xquerydoc (https://github.com/xquery/xquerydoc). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
duncdrum
approved these changes
Feb 21, 2026
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.
Closes #2.
Summary
Adds an API Documentation section to the README covering all public variables and functions in
semver.xqm, generated using xquerydoc.The section includes:
How it was generated
The output was lightly reformatted for better GitHub Markdown rendering (bold param/return labels, inline signatures).
🤖 Generated with Claude Code