RFR: 8223252: Update Javadoc help page with new search features
Jonathan Gibbons
jonathan.gibbons at oracle.com
Wed Nov 13 02:00:07 UTC 2019
Hannes,
It is somewhat weird/non-standard to use resources in this way to create
links, and the decision to put the word "the" outside the link, away
from the content of the link "Javadoc Search Specification" is a bit
idiomatic.
I'd suggest prefixing the resources with comments describing the values
that will be substituted.
# {0} will be replaced by a link derived from the url and title for the
Javadoc Search Specification 222 doclet.help.search.spec.body=Refer to
the {0} for a full description of search features. # The URL for the
Javadoc Search Specification. {0} will be replaced by the JDK version
number 223
doclet.help.search.spec.url=https://docs.oracle.com/en/java/javase/{0}/docs/specs/javadoc/javadoc-search-spec.html
# The title for the Javadoc Search Specification 224 doclet.help.search.spec.title=Javadoc Search Specification
-- Jon
On 11/12/19 2:30 AM, Hannes Wallnöfer wrote:
> Please review:
>
> Bug: https://bugs.openjdk.java.net/browse/JDK-8223252
> Webrev: http://cr.openjdk.java.net/~hannesw/8223252/webrev.00/
>
>
> New help page: http://cr.openjdk.java.net/~hannesw/8223252/api.00/help-doc.html
>
> Changes in the „search“ section of the help page:
>
> - mention of searchable system properties
> - mention and example of partial matches (in addition to camel-case)
> - new paragraph with link to search spec on docs.oracle.com
>
> Thanks,
> Hannes
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/javadoc-dev/attachments/20191112/dac875a6/attachment.html>
More information about the javadoc-dev
mailing list