summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/inflexion/nouns/NounInflection.java
diff options
context:
space:
mode:
authorBen Culkin <scorpress@gmail.com>2020-04-13 18:44:24 -0400
committerBen Culkin <scorpress@gmail.com>2020-04-13 18:44:24 -0400
commit2f6a7807f7180fb467e3d06f2af4263a45759c28 (patch)
treea2c07895dd0f2ab60e864f402e8a38ad0ca0735a /src/main/java/bjc/inflexion/nouns/NounInflection.java
parent5c76def2cdba199ca42ffc440506f6c17624196d (diff)
Cleanup pass
Pass to do some cleanups
Diffstat (limited to 'src/main/java/bjc/inflexion/nouns/NounInflection.java')
-rw-r--r--src/main/java/bjc/inflexion/nouns/NounInflection.java47
1 files changed, 20 insertions, 27 deletions
diff --git a/src/main/java/bjc/inflexion/nouns/NounInflection.java b/src/main/java/bjc/inflexion/nouns/NounInflection.java
index 978efdb..4341183 100644
--- a/src/main/java/bjc/inflexion/nouns/NounInflection.java
+++ b/src/main/java/bjc/inflexion/nouns/NounInflection.java
@@ -25,10 +25,9 @@ public interface NounInflection {
* Check if a noun matches this inflection.
*
* @param noun
- * The noun to check on this inflection.
+ * The noun to check on this inflection.
*
- * @return
- * Whether or not the noun belongs to the inflection.
+ * @return Whether or not the noun belongs to the inflection.
*/
public boolean matches(String noun);
@@ -36,13 +35,12 @@ public interface NounInflection {
* Check if a noun for this inflection is singular or not.
*
* @param noun
- * The noun to check for singularity.
+ * The noun to check for singularity.
*
- * @return
- * Whether or not the noun is singular.
+ * @return Whether or not the noun is singular.
*
* @throws InflectionException
- * If the noun isn't part of this inflection.
+ * If the noun isn't part of this inflection.
*/
public boolean isSingular(String noun);
@@ -50,13 +48,12 @@ public interface NounInflection {
* Check if a noun for this inflection is plural or not.
*
* @param noun
- * The noun to check for plurality.
+ * The noun to check for plurality.
*
- * @return
- * Whether or not the noun is plural.
+ * @return Whether or not the noun is plural.
*
* @throws InflectionException
- * If the noun isn't part of this inflection.
+ * If the noun isn't part of this inflection.
*/
public boolean isPlural(String noun);
@@ -64,13 +61,12 @@ public interface NounInflection {
* Convert a singular noun to a plural noun.
*
* @param plural
- * The plural noun to inflect to a singular form.
+ * The plural noun to inflect to a singular form.
*
- * @return
- * The singular form of the noun.
+ * @return The singular form of the noun.
*
* @throws InflectionException
- * If the noun isn't part of the inflection.
+ * If the noun isn't part of the inflection.
*/
public String singularize(String plural);
@@ -78,13 +74,12 @@ public interface NounInflection {
* Convert a singular noun to a plural noun.
*
* @param singular
- * The singular noun to inflect to a plural form.
+ * The singular noun to inflect to a plural form.
*
- * @return
- * The plural form of the noun.
+ * @return The plural form of the noun.
*
* @throws InflectionException
- * If the noun isn't part of the inflection.
+ * If the noun isn't part of the inflection.
*/
public String pluralize(String singular);
@@ -92,13 +87,12 @@ public interface NounInflection {
* Convert a singular noun to a modern plural noun.
*
* @param singular
- * The singular noun to inflect to a modern plural form.
+ * The singular noun to inflect to a modern plural form.
*
- * @return
- * The modern plural form of the noun.
+ * @return The modern plural form of the noun.
*
* @throws InflectionException
- * If the noun isn't part of the inflection.
+ * If the noun isn't part of the inflection.
*/
public String pluralizeModern(String singular);
@@ -106,13 +100,12 @@ public interface NounInflection {
* Convert a singular noun to a classical plural noun.
*
* @param singular
- * The singular noun to inflect to a classical plural form.
+ * The singular noun to inflect to a classical plural form.
*
- * @return
- * The classical plural form of the noun.
+ * @return The classical plural form of the noun.
*
* @throws InflectionException
- * If the noun isn't part of the inflection.
+ * If the noun isn't part of the inflection.
*/
public String pluralizeClassical(String singular);
}