Loading...

XML

Word

Printable

Type: Enhancement
Resolution: Fixed
Priority: P4
Fix Version/s: 10
Affects Version/s: 9
Component/s: tools
Labels:
- javadoc-inheritance
- javadoc-visibleMemberMap

Subcomponent:
javadoc(tool)
Resolved In Build:
b29

By default javadoc is generated for a method if it overrides a method defined in its supertype.

When a method is overridden with no change in semantic behavior, javadoc currently lists it in the primary method summary just with @inheritdoc. It is not that useful. When many methods are overridden, including inherited docs for these methods in the primary method summary is just noise. Keeping them in "Methods inherited from ..." section would be adequate.

Perhaps javadoc should not bother listing overridden methods that do not have any comment provided to document any change of semantic behavior.

blocks

JDK-8189706 javadoc for the JDK APIs should summarize overridden methods with no specification changes

Resolved

csr for

JDK-8187386 Do not generate javadoc for overridden method with no spec change

Closed

duplicates

JDK-8205590 API Documentation should include one more tab for "added methods"

Closed

relates to

JDK-8296607 Review and specify no-spec-change overrides

Open

JDK-8219147 Javadoc should expose covariant return type overrides

Resolved

JDK-8029891 Deadlock detected in java/lang/ClassLoader/deadlock/GetResource.java

Closed

JDK-8190436 Bug in VisibleMemberMap, including non-deterministic behavior

Closed

JDK-8198890 The standard doclet incorrectly produces wrong method signatures in certain cases.

Closed

JDK-8037423 @treatAsPrivate should hide the member for sub classes

Open

JDK-8189845 Fix for 8157000 causes significant performance regression

Resolved

JDK-8271485 Javadoc "Method Summary" table is misaligned if overridden JDK method has {@inheritDoc} tag

Resolved

JDK-8264217 Overriding method with absent spec is not mentioned as overriding in the JavaSE class specification

Closed

JDK-8199281 Broken link in nav bar "Summary: ... METHOD" when it points to inherited methods of super class.

Closed

JDK-8249070 @inheritDoc does not work if standalone

Closed

(9 relates to)

Release Note: Overriding Methods That Do Not Change the Specification

Closed

Kumar Srinivasan

Assignee:: Kumar Srinivasan

Reporter:: Mandy Chung

Votes:: 0 Vote for this issue

Watchers:: 9 Start watching this issue

Created:: 2016-05-14 14:21

Updated:: 2022-11-08 11:39

Resolved:: 2017-10-19 20:29

Details

Description

Attachments

Issue Links

Sub-Tasks

Activity

People

Dates