Skip to content

Commit

Permalink
minor: corrected leading asterisks alignment in javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Zopsss authored and nrmancuso committed Mar 26, 2024
1 parent b859cee commit 3aa6db2
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 52 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ public class AvoidDefaultSerializableInInnerClassesCheck extends AbstractCheck {
public static final String MSG_KEY = "avoid.default.serializable.in.inner.classes";

/**
* <b>
* Option, that allow partial implementation of serializable interface.
* </b>
*/
* <b>
* Option, that allow partial implementation of serializable interface.
* </b>
*/
private boolean allowPartialImplementation;

/**
Expand Down Expand Up @@ -237,41 +237,41 @@ private static boolean isSerializable(DetailAST classDefNode) {
private final class SiblingIterator {

/**
* <b>
* Next.
* </b>
*/
* <b>
* Next.
* </b>
*/
private DetailAST next;

/**
* <b>
* Children Iterator constructor.
* </b>
*
* @param parent - child parent.
*/
* <b>
* Children Iterator constructor.
* </b>
*
* @param parent - child parent.
*/
/* package */ SiblingIterator(DetailAST parent) {
next = parent.findFirstToken(TokenTypes.METHOD_DEF);
}

/**
* <b>
* Return boolean value, if has next element.
* </b>
*
* @return boolean value
*/
* <b>
* Return boolean value, if has next element.
* </b>
*
* @return boolean value
*/
public boolean hasNextSibling() {
return next != null;
}

/**
* <b>
* Return next DetailAST element.
* </b>
*
* @return next DetailAST.
*/
* <b>
* Return next DetailAST element.
* </b>
*
* @return next DetailAST.
*/

public DetailAST nextSibling() {
final DetailAST result = next;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,32 +24,32 @@
import com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck;

/**
* <p>
* Checks that interface type parameter names conform to a format specified
* by the format property. The format is a
* {@link java.util.regex.Pattern regular expression} and defaults to
* <strong>^[A-Z]$</strong>.
* </p>
* <p>
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;module name="InterfaceTypeParameterName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for names that are only a single
* letter is
* </p>
* <pre>
* &lt;module name="InterfaceTypeParameterName"&gt;
* &lt;property name="format" value="^[a-zA-Z]$"/&gt;
* &lt;/module&gt;
* </pre>
*
* @author Dmitry Gridyushko
* @version 1.0
* @since 1.8.0
*/
* <p>
* Checks that interface type parameter names conform to a format specified
* by the format property. The format is a
* {@link java.util.regex.Pattern regular expression} and defaults to
* <strong>^[A-Z]$</strong>.
* </p>
* <p>
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;module name="InterfaceTypeParameterName"/&gt;
* </pre>
* <p>
* An example of how to configure the check for names that are only a single
* letter is
* </p>
* <pre>
* &lt;module name="InterfaceTypeParameterName"&gt;
* &lt;property name="format" value="^[a-zA-Z]$"/&gt;
* &lt;/module&gt;
* </pre>
*
* @author Dmitry Gridyushko
* @version 1.0
* @since 1.8.0
*/
public class InterfaceTypeParameterNameCheck
extends AbstractNameCheck {

Expand Down

0 comments on commit 3aa6db2

Please sign in to comment.