Hi David,

On 20.08.2025, at 01:47, david Grajales <[email protected]> wrote:

My question is:

  *   Is there any initiative to include more usage examples and concise, 
code-centric explanations in Javadoc?

  *   Or, is there an alternative official documentation site that already 
follows this more example-driven approach?


Note that this list is about development of the JavaDoc tool, not the content 
of API documentation. That is the responsibility of the individual libraries 
that are part of OpenJDK.

My impression is that example code in API docs has improved quite a bit over 
the last years, especially in new APIs, many of them using the new {@snippet} 
tag. But of course there’s always room for improvement. As to other 
documentation that is more example-driven you should be able to find tutorials 
on many APIs, but that is also outside my direct field of activity.

Hannes

Reply via email to