[
https://issues.apache.org/jira/browse/GEODE-10023?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17523015#comment-17523015
]
ASF subversion and git services commented on GEODE-10023:
---------------------------------------------------------
Commit ab5010005f0acb2777968b585723e3ca455195fb in geode's branch
refs/heads/develop from Donal Evans
[ https://gitbox.apache.org/repos/asf?p=geode.git;h=ab5010005f ]
GEODE-10023: Fix javadocs (#7594)
This commit reduces the number of errors reported in the gradle build
log due to javadocs from over 3000 to 0. It also reduces the number of
warnings reported in the gradle build log due to javadocs from over
4000 to 0.
After these changes, all published javadocs are now syntactically
correct, although no guarantee is made as to the content of the
documentation. Javadocs in classes that did not produce warnings or
errors in the gradle build log were not touched.
For classes in the geode-dunit, geode-junit, geode-assembly and
geode-concurrency-test modules, if a javadoc could be converted to
a non-javadoc comment without losing any formatting or tags, it was
converted, since those classes are not intended for use by Geode users
The changes made were:
- Add missing @return, @param and @throws tags
- Fix all errors due to incorrect HTML
- Fix all errors due to improperly escaped characters
- Fix all broken @link tags
- Several minor spelling errors and typos fixed where spotted
In addition to this clean-up, the compiler settings were modified so
that javadocs warnings and errors will be output in the gradle build
log, and if any are present, the build will fail.
Authored-by: Donal Evans <[email protected]>
Co-authored-by: Patrick Johnson <[email protected]>
> Security and management classes have broken javadocs
> ----------------------------------------------------
>
> Key: GEODE-10023
> URL: https://issues.apache.org/jira/browse/GEODE-10023
> Project: Geode
> Issue Type: Bug
> Components: management, security
> Affects Versions: 1.15.0
> Reporter: Kirk Lund
> Assignee: Donal Evans
> Priority: Major
> Labels: needsTriage, pull-request-available
>
> This ticket specifically refers to the javadoc warnings in the build output
> about various broken links and similar details about management classes and
> security classed that are generated when building Geode on the command-line
> with gradle.
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
