Skip to content

docs: improve xdr generator javadocs#784

Merged
overcat merged 2 commits intomasterfrom
chore/xdr-generator-javadocs
Apr 17, 2026
Merged

docs: improve xdr generator javadocs#784
overcat merged 2 commits intomasterfrom
chore/xdr-generator-javadocs

Conversation

@overcat
Copy link
Copy Markdown
Member

@overcat overcat commented Apr 17, 2026

No description provided.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.42%. Comparing base (96214a1) to head (f909f39).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master     #784   +/-   ##
=========================================
  Coverage     81.42%   81.42%           
  Complexity     1473     1473           
=========================================
  Files           220      220           
  Lines          5530     5530           
  Branches        568      568           
=========================================
  Hits           4503     4503           
  Misses          717      717           
  Partials        310      310           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the Javadoc output of the XDR generator so that generated Java sources (and their test snapshots) include more complete API documentation, especially for leaf XDR types and generated fields.

Changes:

  • Added/expanded Javadocs for generated leaf types (e.g., unsigned int/hyper int, strings) covering constants, constructors, encode/decode, and JSON helpers.
  • Added shared Javadocs to XdrElement utilities and to XDR data input/output stream helpers.
  • Updated the generator to emit per-field Javadocs for structs/typedefs/unions and refreshed snapshot outputs accordingly.

Reviewed changes

Copilot reviewed 87 out of 87 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
xdr-generator/generator/generator.rb Adds a helper to emit field-level Javadocs and applies it to structs/typedefs/unions.
xdr-generator/generator/templates/XdrUnsignedInteger.erb Enriches unsigned-int generated type Javadocs (range, constructors, encode/decode, JSON/XDR helpers).
xdr-generator/generator/templates/XdrUnsignedHyperInteger.erb Enriches unsigned-hyper-int generated type Javadocs similarly.
xdr-generator/generator/templates/XdrString.erb Adds class/method Javadocs for generated XDR string type and decoding helpers.
xdr-generator/generator/templates/XdrElement.erb Documents the shared JSON/XDR helpers on the generated base interface.
xdr-generator/generator/templates/XdrDataOutputStream.erb Adds class/ctor/method Javadocs for XDR-aware output stream utilities.
xdr-generator/generator/templates/XdrDataInputStream.erb Adds class/field/method Javadocs for XDR-aware input stream utilities.
xdr-generator/test/snapshots/** Snapshot refresh reflecting the new generator/template Javadoc output.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread xdr-generator/generator/templates/XdrDataOutputStream.erb Outdated
@overcat overcat changed the title docs: improve xdr generator javadocs doc: improve xdr generator javadocs Apr 17, 2026
@overcat overcat changed the title doc: improve xdr generator javadocs docs: improve xdr generator javadocs Apr 17, 2026
@overcat overcat enabled auto-merge (squash) April 17, 2026 08:53
@overcat overcat merged commit 083a485 into master Apr 17, 2026
12 checks passed
@overcat overcat deleted the chore/xdr-generator-javadocs branch April 21, 2026 04:24
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.

2 participants