Repository navigation
docs(release): update documentation, Javadoc, and examples for v1.7.0 release - #97
Merged
Merged
Conversation
Rewrite overview.html to document the full SPI architecture including PersistenceLinter/PersistenceLinterFactory hierarchy, SchemaValidator and SchemaValidatorFactory SPIs, version history (2.0.0 and 2.1.0), all four modules with key classes, and usage examples for query validation, schema validation, and generic factory discovery. Add protected constructor Javadoc to JakartaPersistenceLinterFactory and LegacyPersistenceLinterFactory to fix Javadoc warnings about undocumented default constructors.
- Fix stale Groovydoc in package-info files: correct JPA21 delegate description, add missing JPA22 delegate and TenantValidationExtension entries - Add missing Groovydoc to GenerateJPAGraalVMMetadata.generate(), LintNamedQueries constructor and lint(), and LintNamedQueriesWorker incremental parameters - Fix PersistenceUnitExtension.includeAllClasses default doc (false → true) and improve property()/properties() method documentation - Fix JPA22 delegate class-level doc (plural → singular "specification") - Remove deprecated Platform plugin section from overview.html; add missing task.delegate and task.registry packages - Fix JPA version namespace table in jakarta-plugin.adoc (add JPA 3.1); add missing sourceFiles and lintReportFile task properties - Update plugins/README.md: bump version to 1.7.0, add schema validation to feature list and architecture diagram - Bump plugin versions from 1.6.0 to 1.7.0 in all example build scripts
…ocumentation links - Add "Multi-Tenant Schema Validation" as a new v1.7.0 feature - Remove stale "new in v1.6.0" tag from "Lint Named Queries" feature - Bump plugin version references from 1.6.0 to 1.7.0 in all Getting Started examples (Hibernate and EclipseLink, Groovy and Kotlin DSL) - Split API Reference link into separate Plugins (Groovydoc) and Libraries (Javadoc) links; fix User Guide URL path
yannickebongue
added
the
documentation
4 tasks
yannickebongue
added
libraries
|
|
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.
Summary
Comprehensive documentation refresh for the v1.7.0 release across libraries, plugins, and root project — covering Javadoc/Groovydoc improvements, version bumps, stale content cleanup, and new feature documentation.
This PR touches 22 files across libraries, plugins, and examples with no production logic changes — purely documentation and build script version updates.
Changes
Libraries — Javadoc & Overview (
a1a0285)libraries/src/docs/overview.htmlto document the full SPI architecture:PersistenceLinter/PersistenceLinterFactoryhierarchy,SchemaValidator/SchemaValidatorFactorySPIs, version history (2.0.0 and 2.1.0), all four modules with key classes, and usage examples for query validation, schema validation, and generic factory discovery.JakartaPersistenceLinterFactoryandLegacyPersistenceLinterFactoryto fix Javadoc warnings about undocumented default constructors.Plugins — Groovydoc, AsciiDoc & Examples (
b9a8b6b)TenantValidationExtensionentries, fixedtask.delegateandtask.registrypackage references.GenerateJPAGraalVMMetadata.generate(),LintNamedQueriesconstructor andlint(), andLintNamedQueriesWorkerincremental parameters.PersistenceUnitExtension: fixedincludeAllClassesdefault doc (false→true), improvedproperty()/properties()method documentation.jakarta-plugin.adoc: fixed JPA version namespace table (added JPA 3.1), added missingsourceFilesandlintReportFiletask properties.plugins/src/docs/overview.html: removed deprecated Platform plugin section, added missing task packages.plugins/README.md: bumped version to 1.7.0, added schema validation to feature list and architecture diagram, fixed Groovydoc generation command (aggregateGroovydoc→groovydocAll).1.6.0to1.7.0in all six examplebuild.gradle/build.gradle.ktsfiles (Hibernate, EclipseLink, Jakarta Persistence).Root README (
910fc1e)1.6.0to1.7.0(Groovy DSL and Kotlin DSL, Hibernate and EclipseLink).How to Verify
jakarta-plugin.adoc) for correct JPA version table and new task property entries.1.7.0.