1478908 – javadoc lint errors on openjdk-1.8

RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 1478908 - javadoc lint errors on openjdk-1.8

Summary: javadoc lint errors on openjdk-1.8

Keywords:
Status:	CLOSED WONTFIX
Alias:	None
Product:	Red Hat Enterprise Linux 7
Classification:	Red Hat
Component:	uom-lib
Sub Component:
Version:	7.4
Hardware:	All
OS:	Linux
Priority:	unspecified
Severity:	unspecified
Target Milestone:	rc
Target Release:	---
Assignee:	pcp-maint
QA Contact:	Jan Kurik
Docs Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+	depends on / blocked

Reported:	2017-08-07 13:25 UTC by Pat Riehecky
Modified:	2020-02-25 11:07 UTC (History)
CC List:	2 users (show)
Fixed In Version:
Doc Type:	If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:	2020-02-25 10:56:05 UTC
Target Upstream Version:
Embargoed:

Attachments	(Terms of Use)

Description Pat Riehecky 2017-08-07 13:25:52 UTC

Description of problem:
uom-lib does not build correctly on openjdk-1.8 due to javadoc errors.

Version-Release number of selected component (if applicable):
uom-lib-1.0.1-5.el7

How reproducible:100%


Steps to Reproduce:
1.build package with openjdk-1.8
2.
3.

Actual results:
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9:aggregate (default-cli) on project uom-lib: An error has occurred in JavaDocs report generation:
[ERROR] Exit code: 1 - /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/BinaryPrefix.java:62: warning: no @param for <Q>
[ERROR] public static <Q extends Quantity<Q>> Unit<Q> KIBI(Unit<Q> unit) {
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/BinaryPrefix.java:74: warning: no @param for <Q>
[ERROR] public static <Q extends Quantity<Q>> Unit<Q> MEBI(Unit<Q> unit) {
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/BinaryPrefix.java:86: warning: no @param for <Q>
[ERROR] public static <Q extends Quantity<Q>> Unit<Q> GIBI(Unit<Q> unit) {
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/BinaryPrefix.java:98: warning: no @param for <Q>
[ERROR] public static <Q extends Quantity<Q>> Unit<Q> TEBI(Unit<Q> unit) {
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/BinaryPrefix.java:110: warning: no @param for <Q>
[ERROR] public static <Q extends Quantity<Q>> Unit<Q> PEBI(Unit<Q> unit) {
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/BinaryPrefix.java:122: warning: no @param for <Q>
[ERROR] public static <Q extends Quantity<Q>> Unit<Q> EXBI(Unit<Q> unit) {
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/BinaryPrefix.java:134: warning: no @param for <Q>
[ERROR] public static <Q extends Quantity<Q>> Unit<Q> ZEBI(Unit<Q> unit) {
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/BinaryPrefix.java:146: warning: no @param for <Q>
[ERROR] public static <Q extends Quantity<Q>> Unit<Q> YOBI(Unit<Q> unit) {
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/IntIdentifiable.java:43: error: unexpected content
[ERROR] * @see {@link Identifiable}
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/IntIdentifiable.java:45: warning - Tag @see:illegal character: "123" in "{@link Identifiable}"
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/IntIdentifiable.java:45: warning - Tag @see:illegal character: "64" in "{@link Identifiable}"
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/LongIdentifiable.java:43: error: unexpected content
[ERROR] * @see {@link Identifiable}
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/LongIdentifiable.java:45: warning - Tag @see:illegal character: "123" in "{@link Identifiable}"
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/LongIdentifiable.java:45: warning - Tag @see:illegal character: "64" in "{@link Identifiable}"
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/Parser.java:57: warning: no @param for input
[ERROR] O parse(I input) throws ParserException;
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/Parser.java:57: warning: no @return
[ERROR] O parse(I input) throws ParserException;
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/Parser.java:40: error: reference not found
[ERROR] * >functional interface</a> whose functional method is {@link #parse()}.
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/Parser.java:51: warning - Tag @link: can't find parse() in tec.uom.lib.common.function.Parser
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/QuantityOperator.java:41: warning: empty <p> tag
[ERROR] * <p>
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/QuantityOperator.java:48: error: header used out of sequence: <H4>
[ERROR] * <h4>Implementation specification</h4>
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/QuantitySupplier.java:46: error: unexpected content
[ERROR] * @see {@link Quantity}
[ERROR] ^
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/QuantitySupplier.java:49: warning - Tag @see:illegal character: "123" in "{@link Quantity}"
[ERROR] /builddir/build/BUILD/uom-lib-1.0.1/common/src/main/java/tec/uom/lib/common/function/QuantitySupplier.java:49: warning - Tag @see:illegal character: "64" in "{@link Quantity}"
[ERROR] 
[ERROR] Command line was: /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.141-2.b16.el7_4.x86_64/jre/../bin/javadoc @options @packages
[ERROR] 
[ERROR] Refer to the generated Javadoc files in '/builddir/build/BUILD/uom-lib-1.0.1/target/site/apidocs' dir.
[ERROR] -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR] 
[ERROR] After correcting the problems, you can resume the build with the command
[ERROR]   mvn <goals> -rf :uom-lib

Expected results:
no doclint errors

Additional info:
Builds fine with the relaxed doclint in openjdk-1.7

Comment 2 Nathan Scott 2020-02-25 10:56:05 UTC

Not of sufficient priority that we'll have resources to fix this in RHEL-7 (uom-lib is primarily for use by the parfait package, so the version and JDK targetted is specifically those needed by parfait builds).

Note You need to log in before you can comment on or make changes to this bug.