-
Enhancement
-
Resolution: Fixed
-
P3
-
None
-
b16
When browsing JavaSE API specification for a package that contains complex and large domain area ('java.nio', 'java.security' etc.) sub-packages that a higher level package encloses are often mentioned in the text of the package specification - for example 'java.nio.charset', 'java.nio.channels' are met in the description of 'java.nio' package. However sometimes subpackages are not explicitly mentioned (like for 'java.security') and yet they are not “automatically” being listed in the JavaSE API javadoc along with other entities that particular package encloses (interfaces, classes, enums, exceptions, errors etc.)
So to find out that for example there are
- java.security.cert
- java.security.interfaces
- java.security.spec
enclosed in 'java.security' package user needs to navigate back to the module level spec
https://docs.oracle.com/en/java/javase/15/docs/api/java.base/module-summary.html
or go to “All packages” list
https://docs.oracle.com/en/java/javase/15/docs/api/allpackages-index.html
It is rather surprising that sub packages are not listed in JavaSE API javadoc along with other items that specific package includes.
It seems expected and very convenient that say https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/security/package-summary.html would contain its (sub)package summary with short descriptions, similar to https://docs.oracle.com/en/java/javase/15/docs/api/allpackages-index.html
So to find out that for example there are
- java.security.cert
- java.security.interfaces
- java.security.spec
enclosed in 'java.security' package user needs to navigate back to the module level spec
https://docs.oracle.com/en/java/javase/15/docs/api/java.base/module-summary.html
or go to “All packages” list
https://docs.oracle.com/en/java/javase/15/docs/api/allpackages-index.html
It is rather surprising that sub packages are not listed in JavaSE API javadoc along with other items that specific package includes.
It seems expected and very convenient that say https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/security/package-summary.html would contain its (sub)package summary with short descriptions, similar to https://docs.oracle.com/en/java/javase/15/docs/api/allpackages-index.html
- relates to
-
JDK-8264220 jdk/javadoc/doclet/testRelatedPackages/TestRelatedPackages.java fails to compile
-
- Resolved
-
-
JDK-8265613 False positives for "Related Packages"
-
- Resolved
-
-
JDK-8264202 compilation error in jdk/javadoc/doclet/testRelatedPackages/TestRelatedPackages.java
-
- Closed
-