RFR: 8287333: Clean up ParamTaglet and ThrowsTaglet [v2]

Pavel Rappo prappo at openjdk.java.net
Fri Jun 3 11:34:52 UTC 2022


> A cleanup to facilitate fixing bugs like JDK-6509045: `{@inheritDoc}` only copies one instance of the specified exception.

Pavel Rappo 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 28 additional commits since the last revision:

 - Merge branch 'master' into 8287333
 - Incremental update
   
   - Renames local variables and method parameters
   - Improves comments
   - Removes debug leftovers
 - Update top-level doc comment
 - Trivially re-order assignments
   
   ...for re-use
 - Reformat for clarity
   
   Now it's very clear that the "Throws:" section consists of three types of exceptions:
   
     1. documented
     2. inherited
     3. undocumented
 - Remove dead condition
   
   tagsMap is never empty by the time that check is reached: a mapping being put into it 3 lines above the check.
 - Remove emptiness check
   
   Why bother in this case? It only wastes indentation.
 - Remove comments
   
   Two very similar comments to a private, self-documenting method is a bit too much.
 - Use consistent order
   
   Use "decalred" then "instantiated".
 - Rename and clarify
   
    - Renames a parameter to the throwsTagsOutput method
    - Widens the type of a local variable
 - ... and 18 more: https://git.openjdk.java.net/jdk/compare/efbfef7e...7f1d9324

-------------

Changes:
  - all: https://git.openjdk.java.net/jdk/pull/8886/files
  - new: https://git.openjdk.java.net/jdk/pull/8886/files/03ec6e6f..7f1d9324

Webrevs:
 - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=8886&range=01
 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=8886&range=00-01

  Stats: 53115 lines in 681 files changed: 27116 ins; 19658 del; 6341 mod
  Patch: https://git.openjdk.java.net/jdk/pull/8886.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/8886/head:pull/8886

PR: https://git.openjdk.java.net/jdk/pull/8886


More information about the javadoc-dev mailing list