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

[Jonathan Gibbons]

On Fri, 30 Aug 2024 13:34:23 GMT, Nizar Benalla <nbenalla at openjdk.org> wrote:

>> src/jdk.javadoc/share/classes/jdk/javadoc/doclet/package-info.java line 289:
>> 
>>> 287:  *
>>> 288:  *    // A scanner to loop through specified elements
>>> 289:  *    class ShowFileObjects {
>> 
>> What is the benefit of defining this inner class versus just implementing the `show` method in the doclet class?
>
> I think it was mostly a coding style decision, I wanted to put emphasis on using a scanner

Yeah, I think we need a discussion on what is useful to appear in an example doclet.  I think the old code (lines 253-258) is more relevant to doclet processing than accessing filenames, but maybe there's not much in it.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/20619#discussion_r1738962029