Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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:
|
There was a problem hiding this comment.
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
XdrElementutilities 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.
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.
No description provided.