This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-text.git
The following commit(s) were added to refs/heads/master by this push:
new 252e0d7 Javadoc.
252e0d7 is described below
commit 252e0d7ba80a16641d57569ba6005c07f6a358f4
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Jun 26 12:27:08 2020 -0400
Javadoc.
---
.../org/apache/commons/text/matcher/AbstractStringMatcher.java | 10 +++++-----
.../java/org/apache/commons/text/matcher/StringMatcher.java | 2 +-
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git
a/src/main/java/org/apache/commons/text/matcher/AbstractStringMatcher.java
b/src/main/java/org/apache/commons/text/matcher/AbstractStringMatcher.java
index 3ebf6c3..69e3955 100644
--- a/src/main/java/org/apache/commons/text/matcher/AbstractStringMatcher.java
+++ b/src/main/java/org/apache/commons/text/matcher/AbstractStringMatcher.java
@@ -49,7 +49,7 @@ abstract class AbstractStringMatcher implements StringMatcher
{
}
/**
- * Returns whether or not the given character matches.
+ * Returns {@code 1} if there is a match, or {@code 0} if there is no
match.
*
* @param buffer the text content to match against, do not change
* @param start the starting position for the match, valid for buffer
@@ -93,7 +93,7 @@ abstract class AbstractStringMatcher implements StringMatcher
{
}
/**
- * Returns whether or not the given character matches.
+ * Returns {@code 1} if there is a match, or {@code 0} if there is no
match.
*
* @param buffer the text content to match against, do not change
* @param start the starting position for the match, valid for buffer
@@ -131,7 +131,7 @@ abstract class AbstractStringMatcher implements
StringMatcher {
}
/**
- * Always returns {@code false}.
+ * Always returns {@code 0}.
*
* @param buffer unused
* @param start unused
@@ -175,7 +175,7 @@ abstract class AbstractStringMatcher implements
StringMatcher {
}
/**
- * Returns whether or not the given text matches the stored string.
+ * Returns the number of matching characters, {@code 0} if there is no
match.
*
* @param buffer the text content to match against, do not change
* @param start the starting position for the match, valid for buffer
@@ -232,7 +232,7 @@ abstract class AbstractStringMatcher implements
StringMatcher {
}
/**
- * Returns whether or not the given character matches.
+ * Returns {@code 1} if there is a match, or {@code 0} if there is no
match.
*
* @param buffer the text content to match against, do not change
* @param start the starting position for the match, valid for buffer
diff --git a/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
b/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
index 12c7592..4d5226f 100644
--- a/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
+++ b/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
@@ -25,7 +25,7 @@ package org.apache.commons.text.matcher;
public interface StringMatcher {
/**
- * Returns the number of matching characters, zero if there is no match.
+ * Returns the number of matching characters, {@code 0} if there is no
match.
* <p>
* This method is called to check for a match against a source {@code
buffer}. The parameter {@code start}
* represents the start position to be checked in the array {@code buffer}
(a character array which MUST not be
