stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8247780: Refine the Help page for API Documentation

Browse Source 
Reviewed-by: jjg
This commit is contained in:
Pavel Rappo 2020-06-19 16:42:52 +01:00
parent f2b191a6e9
commit 9d40d80237
1 changed files with 4 additions and 5 deletions

9
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties

@ -144,7 +144,7 @@ doclet.help.package.intro=\
each. These pages may contain six categories:
doclet.help.module.intro=\
Each module has a page that contains a list of its packages, dependencies on other modules, \
and services, with a summary for each. These page may contain three categories:
and services, with a summary for each. These pages may contain three categories:
doclet.help.class_interface.head=\
Class or Interface
doclet.help.class_interface.intro=\
@ -164,7 +164,6 @@ doclet.help.class_interface.declaration=\
doclet.help.class_interface.description=\
Class or Interface Description
doclet.help.class_interface.summary=\
Each summary entry contains the first sentence from the detailed description for that item. \
The summary entries are alphabetical, while the detailed descriptions are in the order they \
appear in the source code. This preserves the logical groupings established by the programmer.
doclet.help.use.head=\
@ -189,7 +188,7 @@ doclet.help.tree.package=\
hierarchy for only that package.
doclet.help.deprecated.body=\
The {0} page lists all of the API that have been deprecated. A deprecated API is not \
recommended for use, generally due to improvements, and a replacement API is usually given. \
recommended for use, generally due to shortcomings, and a replacement API is usually given. \
Deprecated APIs may be removed in future implementations.
doclet.help.index.head=\
Index
@ -198,9 +197,9 @@ doclet.help.index.body=\
and fields, as well as lists of all packages and all classes.
doclet.help.serial_form.body=\
Each serializable or externalizable class has a description of its serialization fields and \
methods. This information is of interest to re-implementors, not to developers using the API. \
methods. This information is of interest to those who implement rather than use the API. \
While there is no link in the navigation bar, you can get to this information by going to any \
serialized class and clicking "Serialized Form" in the "See also" section of the class \
serialized class and clicking "Serialized Form" in the "See Also" section of the class \
description.
doclet.help.constants.body=\
The {0} page lists the static final fields and their values.