Skip to content

Commit c78392d

Browse files
8287606: standardize spelling of subtype and supertype etc in comments
Reviewed-by: prappo
1 parent 5acac22 commit c78392d

File tree

10 files changed

+33
-33
lines changed

10 files changed

+33
-33
lines changed

src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Reporter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
* means the output that is the expected result of executing some operation,
5050
* such as the command-line help that is generated when using a {@code --help} option,
5151
* and "diagnostic output" refers to any errors, warnings and other output that is
52-
* a side-effect of executing the operation.
52+
* a side effect of executing the operation.
5353
*
5454
* <p>The exact manner in which diagnostics are output is unspecified and depends
5555
* on the enclosing context. For example:

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractTreeWriter.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242
/**
4343
* Abstract class to print the class hierarchy page for all the Classes. This
44-
* is sub-classed by {@link PackageTreeWriter} and {@link TreeWriter} to
44+
* is subclassed by {@link PackageTreeWriter} and {@link TreeWriter} to
4545
* generate the Package Tree and global Tree(for all the classes and packages)
4646
* pages.
4747
*/
@@ -66,12 +66,12 @@ protected AbstractTreeWriter(HtmlConfiguration configuration,
6666
}
6767

6868
/**
69-
* Add each level of the class tree. For each sub-class or
70-
* sub-interface indents the next level information.
71-
* Recurses itself to add sub-classes info.
69+
* Add each level of the class tree. For each subclass or
70+
* subinterface indents the next level information.
71+
* Recurses itself to add subclasses info.
7272
*
7373
* @param parent the superclass or superinterface of the sset
74-
* @param collection a collection of the sub-classes at this level
74+
* @param collection a collection of the subclasses at this level
7575
* @param hierarchy the hierarchy for which we are generating a tree
7676
* @param content the content to which the level information will be added
7777
*/

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/Navigation.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,11 +100,11 @@ public enum PageMode {
100100
}
101101

102102
/**
103-
* An interface to provide links for the sub-navigation area.
103+
* An interface to provide links for the subnavigation area.
104104
*/
105105
public interface SubNavLinks {
106106
/**
107-
* {@return a list of links to display in the sub-navigation area}
107+
* {@return a list of links to display in the subnavigation area}
108108
* Links should be wrapped in {@code HtmlTree.LI} elements as they are
109109
* displayed within an unordered list.
110110
*/
@@ -350,9 +350,9 @@ private void addMainNavLinks(Content target) {
350350
}
351351

352352
/**
353-
* Adds the summary links to the sub-navigation.
353+
* Adds the summary links to the subnavigation.
354354
*
355-
* @param target the content to which the sub-navigation will be added
355+
* @param target the content to which the subnavigation will be added
356356
* @param nested whether to create a flat or nested list
357357
*/
358358
private void addSummaryLinks(Content target, boolean nested) {
@@ -381,7 +381,7 @@ private void addSummaryLinks(Content target, boolean nested) {
381381
}
382382

383383
/**
384-
* Adds the detail links to sub-navigation.
384+
* Adds the detail links to subnavigation.
385385
*
386386
* @param target the content to which the links will be added
387387
* @param nested whether to create a flat or nested list

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/BaseConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@
8787
import jdk.javadoc.internal.doclint.DocLint;
8888

8989
/**
90-
* Configure the output based on the options. Doclets should sub-class
90+
* Configure the output based on the options. Doclets should subclass
9191
* BaseConfiguration, to configure and add their own options. This class contains
9292
* all user options which are supported by the standard doclet.
9393
*/

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/BaseOptions.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ public enum ModularityMismatchPolicy {
298298
/**
299299
* Value for command-line option {@code --override-methods summary}
300300
* or {@code --override-methods detail}.
301-
* Specifies whether those methods that override a super-type's method
301+
* Specifies whether those methods that override a supertype's method
302302
* with no changes to the API contract should be summarized in the
303303
* footnote section.
304304
*/
@@ -1048,7 +1048,7 @@ public int sourceTabSize() {
10481048
/**
10491049
* Value for command-line option {@code --override-methods summary}
10501050
* or {@code --override-methods detail}.
1051-
* Specifies whether those methods that override a super-type's method
1051+
* Specifies whether those methods that override a supertype's method
10521052
* with no changes to the API contract should be summarized in the
10531053
* footnote section.
10541054
*/

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractMemberBuilder.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@
3636

3737
/**
3838
* The superclass for all member builders. Member builders are only executed
39-
* within Class Builders. They essentially build sub-components. For example,
40-
* method documentation is a sub-component of class documentation.
39+
* within Class Builders. They essentially build subcomponents. For example,
40+
* method documentation is a subcomponent of class documentation.
4141
*/
4242
public abstract class AbstractMemberBuilder extends AbstractBuilder {
4343

@@ -57,7 +57,7 @@ public AbstractMemberBuilder(Context context, TypeElement typeElement) {
5757
}
5858

5959
/**
60-
* This method is not supported by sub-builders.
60+
* This method is not supported by subbuilders.
6161
*
6262
* @throws AssertionError always
6363
*/

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassTree.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -280,8 +280,8 @@ private void processType(TypeElement typeElement, Hierarchy hierarchy) {
280280

281281
/**
282282
* For the interface passed get the interfaces which it extends, and then
283-
* put this interface in the sub-interface set of those interfaces. Do it
284-
* recursively. If an interface doesn't have super-interface just attach
283+
* put this interface in the subinterface set of those interfaces. Do it
284+
* recursively. If an interface doesn't have superinterface just attach
285285
* that interface in the set of all the baseInterfaces.
286286
*
287287
* @param typeElement Interface under consideration.
@@ -305,18 +305,18 @@ private void processInterface(TypeElement typeElement) {
305305
}
306306

307307
/**
308-
* Return the sub-class set for the class passed.
308+
* Return the subclass set for the class passed.
309309
*
310-
* @param typeElement class whose sub-class set is required.
310+
* @param typeElement class whose subclass set is required.
311311
*/
312312
public SortedSet<TypeElement> subClasses(TypeElement typeElement) {
313313
return hierarchies.get(HierarchyKind.CLASSES).subtypes(typeElement);
314314
}
315315

316316
/**
317-
* Return the sub-interface set for the interface passed.
317+
* Return the subinterface set for the interface passed.
318318
*
319-
* @param typeElement interface whose sub-interface set is required.
319+
* @param typeElement interface whose subinterface set is required.
320320
*/
321321
public SortedSet<TypeElement> subInterfaces(TypeElement typeElement) {
322322
return hierarchies.get(HierarchyKind.INTERFACES).subtypes(typeElement);

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -777,13 +777,13 @@ public TypeMirror getDeclaredType(Collection<TypeMirror> values,
777777
}
778778

779779
/**
780-
* Returns all the implemented super-interfaces of a given type,
781-
* in the case of classes, include all the super-interfaces of
782-
* the supertype. The super-interfaces are collected before the
783-
* super-interfaces of the supertype.
780+
* Returns all the implemented superinterfaces of a given type,
781+
* in the case of classes, include all the superinterfaces of
782+
* the supertype. The superinterfaces are collected before the
783+
* superinterfaces of the supertype.
784784
*
785-
* @param te the type element to get the super-interfaces for.
786-
* @return the list of super-interfaces.
785+
* @param te the type element to get the superinterfaces for.
786+
* @return the list of superinterfaces.
787787
*/
788788
public Set<TypeMirror> getAllInterfaces(TypeElement te) {
789789
Set<TypeMirror> results = new LinkedHashSet<>();
@@ -2810,7 +2810,7 @@ public Set<ElementFlag> elementFlags(Element el) {
28102810
}
28112811

28122812
/**
2813-
* An element can have flags that place it into some sub-categories, like
2813+
* An element can have flags that place it into some subcategories, like
28142814
* being a preview or a deprecated element.
28152815
*/
28162816
public enum ElementFlag {

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,8 +294,8 @@ public boolean isNotSimpleOverride(ExecutableElement e) {
294294
/**
295295
* Returns a set of visible type elements in this type element's lineage.
296296
* <p>
297-
* This method returns the super-types in the inheritance
298-
* order C, B, A, j.l.O. The super-interfaces however are
297+
* This method returns the supertypes in the inheritance
298+
* order C, B, A, j.l.O. The superinterfaces however are
299299
* alpha sorted and appended to the resulting set.
300300
*
301301
* @return the set of visible classes in this map

src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/ElementsTable.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -806,7 +806,7 @@ private void addFilesForParser(Collection<JavaFileObject> result,
806806
/**
807807
* Returns an aggregated list of java file objects from the items
808808
* specified on the command line. The packages specified should not
809-
* recurse, however sub-packages should recurse into the sub directories.
809+
* recurse, however subpackages should recurse into the subdirectories.
810810
* @return a list of java file objects
811811
* @throws IOException if an error occurs
812812
*/

0 commit comments

Comments
 (0)