Skip to content

Commit

Permalink
supplemental: add missing javadocs (checkstyle#10818)
Browse files Browse the repository at this point in the history
  • Loading branch information
pbludov authored and romani committed Sep 25, 2021
1 parent afdf3de commit ba56825
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2127,6 +2127,11 @@ private void advanceChildToEnd() {
}
}

/**
* Returns the root node.
*
* @return the root node
*/
private DetailAstImpl getRoot() {
return root;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -665,18 +665,38 @@ private static class ResourceBundle {
files = new HashSet<>();
}

/**
* Returns the bundle base name.
*
* @return the bundle base name
*/
public String getBaseName() {
return baseName;
}

/**
* Returns the common path of files which are included in the resource bundle.
*
* @return the common path of files
*/
public String getPath() {
return path;
}

/**
* Returns the common extension of files which are included in the resource bundle.
*
* @return the common extension of files
*/
public String getExtension() {
return extension;
}

/**
* Returns the set of files which are included in the resource bundle.
*
* @return the set of files
*/
public Set<File> getFiles() {
return Collections.unmodifiableSet(files);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1307,14 +1307,29 @@ private void addIdent(DetailAST identToAdd) {
varIdents.add(identToAdd);
}

/**
* Returns the parent frame.
*
* @return the parent frame
*/
protected AbstractFrame getParent() {
return parent;
}

/**
* Returns the name identifier text.
*
* @return the name identifier text
*/
protected String getFrameName() {
return frameNameIdent.getText();
}

/**
* Returns the name identifier token.
*
* @return the name identifier token
*/
public DetailAST getFrameNameIdent() {
return frameNameIdent;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ public String toString() {
return getName();
}

/**
* Returns the access modifier name.
*
* @return the access modifier name
*/
private String getName() {
return name().toLowerCase(Locale.ENGLISH);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -381,8 +381,8 @@ private static class MethodCounter {
/** Maintains the counts. */
private final Map<Scope, Integer> counts = new EnumMap<>(Scope.class);
/**
* The surrounding scope definition (class, enum, etc.) which the method counts are connect
* to.
* The surrounding scope definition (class, enum, etc.) which the method counts are
* connected to.
*/
private final DetailAST scopeDefinition;
/** Tracks the total. */
Expand Down Expand Up @@ -423,6 +423,12 @@ private int value(Scope scope) {
return value;
}

/**
* Returns the surrounding scope definition (class, enum, etc.) which the method counts
* are connected to.
*
* @return the surrounding scope definition
*/
private DetailAST getScopeDefinition() {
return scopeDefinition;
}
Expand Down

0 comments on commit ba56825

Please sign in to comment.