Skip to content

Comments

Add API documentation to README#67

Merged
duncdrum merged 1 commit intoeXist-db:masterfrom
joewiz:add-api-docs
Feb 21, 2026
Merged

Add API documentation to README#67
duncdrum merged 1 commit intoeXist-db:masterfrom
joewiz:add-api-docs

Conversation

@joewiz
Copy link
Member

@joewiz joewiz commented Feb 21, 2026

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:

  • A table of contents linking to every variable and function
  • Signature, description, params, return type, and errors for each entry
  • Anchor links for direct deep-linking to individual functions

How it was generated

# From the xquerydoc repo:
java -Xss16m -cp "target/dependency/*" net.sf.saxon.Query \
  -q:- "semverpath=file:///path/to/semver.xq/src/main/xquery/semver.xqm" \
  <<< '...' > semver-xqdoc.xml

java -cp "target/dependency/*" net.sf.saxon.Transform \
  -s:semver-xqdoc.xml \
  -xsl:src/lib/markdown-module.xsl \
  -o:semver-api.md

The output was lightly reformatted for better GitHub Markdown rendering (bold param/return labels, inline signatures).

🤖 Generated with Claude Code

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 duncdrum merged commit 99f974c into eXist-db:master Feb 21, 2026
7 checks passed
@joewiz joewiz deleted the add-api-docs branch February 21, 2026 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add xqdoc to README.md for quick reference

2 participants