Modernize Javadoc across all modules for 1.0.0#274
Merged
Splatcrafter merged 3 commits intodevelopfrom Apr 21, 2026
Merged
Conversation
Align Javadoc examples and cross-references with the current 1.0.0 API so the generated docs reflect the library as shipped. - Replace outdated method references and fictional APIs (DataVersion.of, DSL.allWithRemainder/ref, Rules.sequence/restructure, schema.typeRegistry, hasPartialResult, DataFixerBuilder.create, withContext) with their real counterparts. - Update rewrite package-info and DataFix/Fixes/SchemaDataFix samples to use the current Rules DSL (including groupFields) and the correct SchemaDataFix constructor. - Document the diagnostic package, field-aware rules, DiagnosticContext wiring, and captureFieldDetails introduced in 1.0.0 in the API and core package-infos. - Fix DynamicOps link to non-existent #isNull, Pair accessor names, DataResult mapError signature, and the registerFixes/registerSchemas examples that were missing TypeReferences or using bogus overloads. - Bump visible version strings and Maven coordinates to 1.0.0 in the CLI, Spring Boot starter, and examples. - Add captions to every <table> and promote nested <h3> to <h4> in the benchmarks module so `mvn javadoc:javadoc` succeeds across the whole build. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Erik Pförtner <splatcrafter@splatgames.de>
…ocumentation-for-1.0.0 # Conflicts: # aether-datafixers-api/src/main/java/de/splatgames/aether/datafixers/api/dynamic/DynamicOps.java # aether-datafixers-core/src/main/java/de/splatgames/aether/datafixers/core/fix/SchemaDataFix.java
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
The CLI --version output was bumped to 1.0.0 in 7b9dfc8 but the corresponding test in AetherCliTest still asserted "0.3.0", causing the pipeline to fail. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Erik Pförtner <splatcrafter@splatgames.de>
Splatcrafter
force-pushed
the
refactor/enhance-documentation-for-1.0.0
branch
from
1daabf8 to
1023814
Compare
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.
Summary
Align Javadoc examples and cross-references with the real 1.0.0 API so the generated docs reflect the library as shipped. Outdated/fictional APIs and incorrect links had accumulated across package-infos and core types; this sweep corrects them and makes
mvn javadoc:javadocsucceed across the whole build.Type of Change
Related Issues
n/a — documentation-only sweep in preparation for the 1.0.0 release.
Changes
DataVersion.of,DSL.allWithRemainder/ref,Rules.sequence/restructure,schema.typeRegistry,hasPartialResult,DataFixerBuilder.create,withContext) with their real counterparts.rewritepackage-info andDataFix/Fixes/SchemaDataFixsamples to use the currentRulesDSL (includinggroupFields) and the correctSchemaDataFixconstructor.diagnosticpackage, field-aware rules,DiagnosticContextwiring, andcaptureFieldDetailsintroduced in 1.0.0 in the API and core package-infos.DynamicOpslink to the non-existent#isNull, correctPairaccessor names, theDataResult#mapErrorsignature, and theregisterFixes/registerSchemasexamples that were missingTypeReferences or using bogus overloads.<table>and promote nested<h3>to<h4>in the benchmarks module somvn javadoc:javadocsucceeds across the whole build.Verification
mvn javadoc:javadocsucceeds across all modules.Breaking Changes
None. Documentation-only — no public API, behavior, or binary compatibility changes.
AI Disclosure
Co-Authored-Bytrailer on the commit.See AI Usage Guidelines for details.
Checklist
🤖 Generated with Claude Code