4743537: Help doesn't say what "All Classes" and other links really mean

Tue, 15 Mar 2011 14:19:00 -0700

author
bpatel
date
Tue, 15 Mar 2011 14:19:00 -0700
changeset 934
480de7832e2f
parent 933
0f9e5b7f0d7e
child 935
5b29f2a85085

4743537: Help doesn't say what "All Classes" and other links really mean
Reviewed-by: jjg

src/share/classes/com/sun/tools/doclets/formats/html/HelpWriter.java file | annotate | diff | comparison | revisions
src/share/classes/com/sun/tools/doclets/formats/html/resources/standard.properties file | annotate | diff | comparison | revisions
     1.1 --- a/src/share/classes/com/sun/tools/doclets/formats/html/HelpWriter.java	Tue Mar 15 11:48:55 2011 -0700
     1.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/HelpWriter.java	Tue Mar 15 14:19:00 2011 -0700
     1.3 @@ -283,23 +283,32 @@
     1.4          Content framePara = HtmlTree.P(line26);
     1.5          liFrame.addContent(framePara);
     1.6          ul.addContent(liFrame);
     1.7 +        Content allclassesHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
     1.8 +                getResource("doclet.All_Classes"));
     1.9 +        Content liAllClasses = HtmlTree.LI(HtmlStyle.blockList, allclassesHead);
    1.10 +        Content line27 = getResource("doclet.Help_line_27",
    1.11 +                getHyperLinkString("allclasses-noframe.html",
    1.12 +                configuration.getText("doclet.All_Classes")));
    1.13 +        Content allclassesPara = HtmlTree.P(line27);
    1.14 +        liAllClasses.addContent(allclassesPara);
    1.15 +        ul.addContent(liAllClasses);
    1.16          Content sHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
    1.17                  getResource("doclet.Serialized_Form"));
    1.18          Content liSerial = HtmlTree.LI(HtmlStyle.blockList, sHead);
    1.19 -        Content line27 = getResource("doclet.Help_line_27");
    1.20 -        Content serialPara = HtmlTree.P(line27);
    1.21 +        Content line28 = getResource("doclet.Help_line_28");
    1.22 +        Content serialPara = HtmlTree.P(line28);
    1.23          liSerial.addContent(serialPara);
    1.24          ul.addContent(liSerial);
    1.25          Content constHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
    1.26                  getResource("doclet.Constants_Summary"));
    1.27          Content liConst = HtmlTree.LI(HtmlStyle.blockList, constHead);
    1.28 -        Content line28 = getResource("doclet.Help_line_28");
    1.29 -        Content constPara = HtmlTree.P(line28);
    1.30 +        Content line29 = getResource("doclet.Help_line_29");
    1.31 +        Content constPara = HtmlTree.P(line29);
    1.32          liConst.addContent(constPara);
    1.33          ul.addContent(liConst);
    1.34          Content divContent = HtmlTree.DIV(HtmlStyle.contentContainer, ul);
    1.35 -        Content line29 = HtmlTree.EM(getResource("doclet.Help_line_29"));
    1.36 -        divContent.addContent(line29);
    1.37 +        Content line30 = HtmlTree.EM(getResource("doclet.Help_line_30"));
    1.38 +        divContent.addContent(line30);
    1.39          contentTree.addContent(divContent);
    1.40      }
    1.41  
     2.1 --- a/src/share/classes/com/sun/tools/doclets/formats/html/resources/standard.properties	Tue Mar 15 11:48:55 2011 -0700
     2.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/resources/standard.properties	Tue Mar 15 14:19:00 2011 -0700
     2.3 @@ -164,9 +164,10 @@
     2.4  doclet.Help_line_24=These links take you to the next or previous class, interface, package, or related page.
     2.5  doclet.Help_line_25=Frames/No Frames
     2.6  doclet.Help_line_26=These links show and hide the HTML frames.  All pages are available with or without frames.
     2.7 -doclet.Help_line_27=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. 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 description.
     2.8 -doclet.Help_line_28=The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.
     2.9 -doclet.Help_line_29=This help file applies to API documentation generated using the standard doclet.
    2.10 +doclet.Help_line_27=The {0} link shows all classes and interfaces except non-static nested types.
    2.11 +doclet.Help_line_28=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. 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 description.
    2.12 +doclet.Help_line_29=The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.
    2.13 +doclet.Help_line_30=This help file applies to API documentation generated using the standard doclet.
    2.14  doclet.Help_enum_line_1=Each enum has its own separate page with the following sections:
    2.15  doclet.Help_enum_line_2=Enum declaration
    2.16  doclet.Help_enum_line_3=Enum description

mercurial