[
https://issues.apache.org/jira/browse/GEODE-10483?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jinwoo Hwang updated GEODE-10483:
---------------------------------
Fix Version/s: 2.1.0
> Migration of Javadoc to HTML5 with Java 17 upgrade
> --------------------------------------------------
>
> Key: GEODE-10483
> URL: https://issues.apache.org/jira/browse/GEODE-10483
> Project: Geode
> Issue Type: Improvement
> Reporter: Jinwoo Hwang
> Assignee: Jinwoo Hwang
> Priority: Major
> Fix For: 2.1.0
>
>
> Currently, Javadoc generation has strict HTML checking disabled via
> {{options.addStringOption('Xdoclint:none', '-quiet')}} in geode-java.gradle.
> This was added for "Java 17 compatibility" but masks underlying documentation
> quality issues that should be addressed.
> *Assessment Results:* When doclint is enabled, the build fails with about
> _200 documentation issues_ in the geode-core module alone:
> * about 100 errors (build-blocking)
> * about 100 warnings
> *Issue Breakdown:*
> * Missing Javadoc comments: 64 issues
> * HTML5 incompatible attributes (name): 50 issues
> * Deprecated HTML tags (tt): 38 issues
> * Empty paragraph tags: 36 issues
> * Incorrect heading hierarchy: 7 issues
> * Table issues (summary): 4 issues
> * Obsolete tags (CENTER): 1 issue
> *Acceptance Criteria:*
> * Replace all {{<tt>}} tags with {{<code>}} tags (38 fixes)
> * Remove deprecated {{name}} attributes from HTML elements (50 fixes)
> * Remove empty {{<p>}} and {{<P>}} tags (36 fixes)
> * Replace {{<CENTER>}} tags with HTML5 alternatives (1 fix)
> * Add missing Javadoc comments for public APIs (64 fixes)
> * Fix heading hierarchy issues (7 fixes)
> * Add proper table summaries (4 fixes)
> * Remove {{options.addStringOption('Xdoclint:none', '-quiet')}} from build
> config
> * Verify clean Javadoc generation across all modules
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
