RFR: 8322036: Improve help output from the javadoc tool [v3]
Nizar Benalla
nbenalla at openjdk.org
Thu Aug 22 18:11:17 UTC 2024
On Tue, 20 Aug 2024 14:43:24 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:
>> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties line 481:
>>
>>> 479:
>>> 480: doclet.usage.docfilessubdirs.description=\
>>> 481: Enables deep copying of `doc-files` directories. Subdirectories and all\n\
>>
>> Here and elsewhere: backticks mean code font in Markdown files you copied this message from, but they mean nothing in the console.
>>
>> In other properties files, we don't use backticks for such purposes. The closest we have is this in jar.properties:
>>
>> main.usage.summary.try=\
>> Try `jar --help' for more information.
>>
>> I think we can safely strip backticks throughout this PR. @jonathan-gibbons, thoughts?
>
> They should not be removed/deleted. They could be replaced with single quotes `'` but IIRC they sometimes? have to be doubled in properties files.
Fixed in [e24bbd8](https://github.com/openjdk/jdk/pull/20618/commits/e24bbd8d6c1f55f2e43ad453703c26105d0b4e7a), thanks.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/20618#discussion_r1727602121
More information about the javadoc-dev
mailing list