RFR: 8333230: Improve code example in doclet package [v2]

Nizar Benalla nbenalla at openjdk.org
Mon Aug 19 16:35:29 UTC 2024


> Can I please get a review for this simple change? It's an attempt to improve the code example in doclet package.
> Here are the generated docs with the [new code example.](https://cr.openjdk.org/~nbenalla/GeneratedDocs/newDocletExample/api/jdk.javadoc/jdk/javadoc/doclet/package-summary.html#Example.java)
> 
> I tried to go for simplicity while showing some features of the standard doclet, running this Doclet on a small project gives the following ouput.
> 
> 
> Note: org.example.Example -> src/main/java/org/example/Example.java CLASS
> Note: org.example.SimpleDoclet -> src/main/java/org/example/SimpleDoclet.java CLASS
> 
> 
> 
> TIA

Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision:

  rename SimpleDoclet to Example so that TestDocletExample.java passes

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

Changes:
  - all: https://git.openjdk.org/jdk/pull/20619/files
  - new: https://git.openjdk.org/jdk/pull/20619/files/a83c3300..a909bfa8

Webrevs:
 - full: https://webrevs.openjdk.org/?repo=jdk&pr=20619&range=01
 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=20619&range=00-01

  Stats: 1 line in 1 file changed: 0 ins; 0 del; 1 mod
  Patch: https://git.openjdk.org/jdk/pull/20619.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/20619/head:pull/20619

PR: https://git.openjdk.org/jdk/pull/20619


More information about the javadoc-dev mailing list