RFR: JDK-8282559: Allow multiple search terms in javadoc search [v3]

Jonathan Gibbons jjg at openjdk.java.net
Wed May 4 20:36:57 UTC 2022


On Tue, 19 Apr 2022 12:45:18 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

>> Please review the first of two PRs to enhance JavaDoc search. 
>> 
>> This one focuses on the existing search script, to which it adds the feature to search for multiple terms. It also improves the implementation of case-sensitive search as well as rating of matches and provides some general update and refactoring of the script.
>> 
>> The search section in the help page is updated to mention the multiple search term feature, and I repurposed the last example to show the new feature.
>> 
>> The new search function can be tested here (top-level API doc files only):
>> http://cr.openjdk.java.net/~hannesw/8282559/api.00/
>
> Hannes Wallnöfer has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Improve help text

Approved, with a grammar suggestion.

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties line 328:

> 326: doclet.help.search.intro=You can search for definitions of modules, packages, types, fields, methods, \
> 327:     system properties and other terms defined in the API. These items can be searched using part or all \
> 328:     of the name, optionally using "camelCase" abbreviations or multiple search terms separated by whitespace. \

Suggest a comma between "abbreviations" and "or multiple search terms"

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

Marked as reviewed by jjg (Reviewer).

PR: https://git.openjdk.java.net/jdk/pull/8185


More information about the javadoc-dev mailing list