JDK-8163332 : [Doclet API] address isVisible() and shouldDocument()
  • Type: Sub-task
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 9
  • Priority: P2
  • Status: Resolved
  • Resolution: Duplicate
  • OS: generic
  • CPU: generic
  • Submitted: 2016-08-07
  • Updated: 2016-08-18
  • Resolved: 2016-08-18
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 9
9Resolved
Related Reports
Duplicate :  
Description
These methods are needed by the doclet, and are javadoc/doclet specific.

isIncluded():
an element is included if,
    - included lists contains the element 
    - shouldDocument is true

shouldDocument():
An element must be documented if:
   - the element is not SYNTHETIC
   - allowed by the user's selection filtering (ModifierFilter)

   if TYPE then
       - not SYNTHETIC
       - excluded non source types (classes-path vs source-path)
       - can be documented (isVisible)

isVisible():
A type element is said to be visible (could be documented) if:
    - allowed by the user's selection filtering (ModifierFilter)
    - a nested type then, the enclosing type is:
      -  STATIC
      OR
      - could be documented ie. visible

We need to incorporate isVisible and shouldDocument in DocletEnvironment,
it may be possible to fold the capability of isVisible completely into shouldDocument
thereby eliminating the need to expose isVisible.


Comments
JDK-8164395 subsumes this issue.
18-08-2016