fix: resolve Javadoc warnings#8
Merged
Merged
Conversation
Add missing Javadoc comments and main descriptions across core and toolkit modules so that 'mvn clean javadoc:javadoc' completes with zero warnings. - Document all public SAML URI/constant values in Constants.java - Add main descriptions to getters/setters and builder methods - Document exception classes, error-code constants and constructors - Fill in empty @param/@return tags and missing type-param docs Only Javadoc was changed; no behavior, signatures or constant values were modified. A few explicit empty no-arg constructors were added solely to satisfy doclint's default-constructor warning (behavior unchanged).
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
1 participant
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.
Resolves all Javadoc warnings reported by
mvn clean javadoc:javadoc(269 in total: 178 "no comment", 80 "no main description", plus a handful of missing/empty@param/@returntags and default-constructor warnings) across 34 files in the core and toolkit modules.Changes are Javadoc-only:
Constants.java.@param/@returntags.@param/@returndescriptions and the missing@param <T>/@param statusXpathtags.No behavior, method signatures or constant values were changed. A few explicit empty no-arg constructors were added solely to satisfy doclint's "use of default constructor" warning; they are behaviorally identical to the implicit defaults.
Verified:
mvn clean javadoc:javadocnow reports BUILD SUCCESS with zerowarning:and zeroerror:lines, andmvn clean compilesucceeds.