[
https://issues.apache.org/jira/browse/HBASE-30235?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Gianmarco Schifone updated HBASE-30235:
---------------------------------------
Description:
Some Javadoc comments in HBase cannot be processed by the JDK javadoc tool with
-Xdoclint:syntax.
Examples include:
- a raw URL used directly in an @see tag
- raw angle-bracket text such as <100MB, 120MB, 0>
- raw comparison text such as size < acceptable
These are parsed as invalid Javadoc/HTML by the JDK doclet and cause doclint
syntax errors.
was:
Some existing Javadocs cannot be processed by the JDK javadoc tool with
-Xdoclint:syntax.
The patch fixes:
- a raw URL in an @see tag
- raw <...> counter examples
- raw size < ... expressions
Validated on the affected files with javadoc -Xdoclint:syntax
> Fix Javadoc syntax errors
> -------------------------
>
> Key: HBASE-30235
> URL: https://issues.apache.org/jira/browse/HBASE-30235
> Project: HBase
> Issue Type: Bug
> Reporter: Gianmarco Schifone
> Priority: Minor
>
> Some Javadoc comments in HBase cannot be processed by the JDK javadoc tool
> with -Xdoclint:syntax.
> Examples include:
> - a raw URL used directly in an @see tag
> - raw angle-bracket text such as <100MB, 120MB, 0>
> - raw comparison text such as size < acceptable
> These are parsed as invalid Javadoc/HTML by the JDK doclet and cause doclint
> syntax errors.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
