> This adds a "Related Packages" table to package summary pages with a list of > neighboring tables. The rules for including packages is as follows: > > 1. The super package of the current package is included if it exists. > 2. Direct subpackages of the current package are included, but only if their > number does not exceed 20, in which case no subpackages are included. > 3. If steps 1 and 2 did not produce more than 5 packages, sibling packages > of the current package are included, but only if their number is not greater > than 5. > > In steps 2. and 3. above, either all or no candidate packages are included. > In other words, if the threshold is exceeded none of the candidate packages > are included in the list. The cut-off values are arbitrary, but have shown to > produce reasonably good results with various codebases. > > A few example of API documentation generated with this feature: > > http://cr.openjdk.java.net/~hannesw/8260388/api.01/ > http://cr.openjdk.java.net/~hannesw/8260388/javafx.01/ > http://cr.openjdk.java.net/~hannesw/8260388/tomcat.02/ > http://cr.openjdk.java.net/~hannesw/8260388/servlet.01/ > > This is a first step to introduce the new feature. There may be future > enhancements to fine-tune the feature or make it more customizable.
Hannes Wallnöfer has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains three additional commits since the last revision: - JDK-8260388: Show module column in related packages table if packages are in different modules - Merge branch 'master' into JDK-8260388 - JDK-8260388: Listing (sub)packages at package level of API documentation ------------- Changes: - all: https://git.openjdk.java.net/jdk/pull/2917/files - new: https://git.openjdk.java.net/jdk/pull/2917/files/71f0ffc5..eb87b397 Webrevs: - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=2917&range=01 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=2917&range=00-01 Stats: 47019 lines in 1974 files changed: 31518 ins; 8854 del; 6647 mod Patch: https://git.openjdk.java.net/jdk/pull/2917.diff Fetch: git fetch https://git.openjdk.java.net/jdk pull/2917/head:pull/2917 PR: https://git.openjdk.java.net/jdk/pull/2917
