Javadoc search [JEP-225]
Prior to Java 9, the standard Doclet generated API documentation pages that made navigating them difficult. Unless you are very familiar with the layout of these documentation pages, you will likely use browser-based find functionality to search text. This is considered clunky and suboptimal.
The Java 9 platform includes a search box as part of the API documentation. This search box is granted by the standard Doclet and can be used to search for text within the documentation. This represents a great convenience for developers and is likely to change our usage of Doclet-generated documentation.
With the new Javadoc search functionality, we have the ability to search for the following indexed components:
- Module names
- Package names
- Types
- Members
- Terms/phrases indexed using the new
@index
inline tag
Introducing camel case search
The new Javadoc search functionality includes a great shortcut using camel case search. As an example, we can search for openED
to find the openExternalDatabase...