RFR: 8244535: JavaDoc search is overly strict with letter case
Pavel Rappo
pavel.rappo at oracle.com
Thu Nov 26 20:36:01 UTC 2020
When I punch in `ToolProvider` I see 3 results in JDK 15 and 2 results on this change's sample page. Advantages are unclear.
[JDK 15](https://docs.oracle.com/en/java/javase/15/docs/api/index.html):
Types
java.util.spi.ToolProvider
javax.tools.ToolProvider
Members
javax.tools.ToolProvider.ToolProvider()
[This change's sample page](http://cr.openjdk.java.net/~hannesw/8244535/api.01/):
Types
java.util.spi.ToolProvider
javax.tools.ToolProvider
Do you see a different picture?
> On 26 Nov 2020, at 20:09, Jonathan Gibbons <jonathan.gibbons at oracle.com> wrote:
>
> Pavel,
>
> The way I read the code changes, you need to find examples of classes with the same name but in different packages. The example that came to mind for me is `ToolProvider`.
>
> -- Jon
>
> On 11/26/20 8:51 AM, Pavel Rappo wrote:
>> On Fri, 20 Nov 2020 15:00:56 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:
>>
>>> This PR softens the case-sensitivity rules in Javadoc searches by including results of case-insensitive search if a case-sensitive yields no or very few results.
>>>
>>> Changes also include some restructuring of the search.js code along with minor changes that improve compliance with the specification (Segments separated by `_` are ranked the same way as segments of CamelCase identifiers, and matches on such segments are ranked lower than matches for whole identifiers, which wasn't always the case previously)
>>>
>>> The `TestSearchScript.java` test, which has been disabled with the removal of Nashorn, has been updated to run without failure. In the process, I noticed that the recent IndexBuilder|Writer|Item refactoring, comparators have been unified to the point that the same item order is used in HTML index pages and the search index JSON files. However, there used to be slight differences in the sorting between the two. This change restores the original order by adding two simple search index comparators to `IndexBuilder.java`.
>>>
>>> API documentation generated with this PR applied can be viewed and tested here:
>>> http://cr.openjdk.java.net/~hannesw/8244535/api.01/
>> @hns, could you recommend (at least several different) example searches that would clearly show the advantages of this proposal over [JDK 15](https://docs.oracle.com/en/java/javase/15/docs/api/index.html)? Although the are examples in tests, they are contrived (naturally). It would be nice to see how this improves search on a real codebase, such as the JDK codebase.
>>
>> -------------
>>
>> PR: https://git.openjdk.java.net/jdk/pull/1354
More information about the javadoc-dev
mailing list