RFR: 8333230: Improve code example in doclet package
Nizar Benalla
nbenalla at openjdk.org
Fri Aug 16 17:13:24 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
-------------
Commit messages:
- Update Doclet code example
Changes: https://git.openjdk.org/jdk/pull/20619/files
Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=20619&range=00
Issue: https://bugs.openjdk.org/browse/JDK-8333230
Stats: 112 lines in 1 file changed: 35 ins; 44 del; 33 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