diff --git a/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/AbstractBrailleTableParser.java b/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/AbstractBrailleTableParser.java index b02f4c495b3c250329458693ab835e1b3f7df91b..8cec3abe0b9fe1e41d34f98790d69e1a1ddeb578 100644 --- a/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/AbstractBrailleTableParser.java +++ b/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/AbstractBrailleTableParser.java @@ -1,14 +1,14 @@ package de.tudresden.inf.mci.brailleplot.brailleparser; /** - * Defines an Interface which should be implemented in all Parsers of Brailletables. + * Defines an Interface which should be implemented in all Parsers of Braille tables. */ public interface AbstractBrailleTableParser { /** * Common Method for querying the BrailleTable. - * @param key Braillecell, represented as String ("111000). - * @return Byte, represented as int, corresponding to the given Braillecell. + * @param key Braille cell, represented as String ("111000). + * @return Byte, represented as int, corresponding to the given Braille cell. */ int getValue(String key); diff --git a/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/JsonParser.java b/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/JsonParser.java index 5febe7b4dab8e355266ffe3d278186c98fba1b03..99d70964f251dfe68c1b86b59ffa178d5745e42d 100644 --- a/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/JsonParser.java +++ b/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/JsonParser.java @@ -9,7 +9,7 @@ public class JsonParser implements AbstractBrailleTableParser { /** * Currently not supported. - * @param filePath File path to the Brailletable. + * @param filePath File path to the Braille table. */ public JsonParser(final String filePath) { throw new UnsupportedOperationException(); @@ -18,8 +18,8 @@ public class JsonParser implements AbstractBrailleTableParser { /** * Currently not supported. - * @param key Braillecell, represented as String ("111000). - * @return The Byte(int) representing the Braillecell specified in the BrailleTable. + * @param key Braille cell, represented as String ("111000). + * @return The Byte(int) representing the Braille cell specified in the BrailleTable. */ @Override public int getValue(final String key) { diff --git a/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/PropertiesParser.java b/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/PropertiesParser.java index facc8eabeea34f1fe7d87017f22049aa741fd9df..4b2dba1ed706472ac1e70d4b723d8d095685fd43 100644 --- a/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/PropertiesParser.java +++ b/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/PropertiesParser.java @@ -14,7 +14,7 @@ public class PropertiesParser implements AbstractBrailleTableParser { private Properties mProperties = new Properties(); /** - * Constructor for PropertiesParser. Takes an filePath to the Brailletable file with the .properties filextension. + * Constructor for PropertiesParser. Takes an filePath to the Braille table file with the .properties file xtension. * @param filePath The Path to the BrailleTable. * @throws RuntimeException if the file Path does not exists. */ @@ -33,9 +33,9 @@ public class PropertiesParser implements AbstractBrailleTableParser { } /** - * Method for querying the Byte (represented via int) for a given Cell from the BrailleTable. - * @param key The Braillecell, represented as a String (for example "111000" for 6 BrailleCell). - * @return The Byte(int) representing the Braillecell specified in the BrailleTable, + * Method for querying the Byte (represented via int) for a given Cell from the braille table. + * @param key The Braille cell, represented as a String (for example "111000" for 6 BrailleCell). + * @return The Byte(int) representing the Braille cell specified in the braille table, */ @Override public int getValue(final String key) { diff --git a/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/XmlParser.java b/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/XmlParser.java index eb63492c2fc2aab67fd29dae768904f1d1679a47..6898ad84f4ab75690a4ea3d8c76e2606cae433cb 100644 --- a/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/XmlParser.java +++ b/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/XmlParser.java @@ -21,8 +21,8 @@ public class XmlParser implements AbstractBrailleTableParser { /** * Currently not supported. - * @param key Braillecell, represented as String ("111000). - * @return The Byte(int) representing the Braillecell specified in the BrailleTable. + * @param key braille cell, represented as String ("111000). + * @return The Byte(int) representing the Braille cell specified in the braille table. */ @Override public int getValue(final String key) { diff --git a/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/package-info.java b/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/package-info.java index 1a35a44068aefaf23261ccbabaa89e93d387dfdc..9180787101d951fbd977c9235d4c3cb49adc4f7c 100644 --- a/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/package-info.java +++ b/src/main/java/de/tudresden/inf/mci/brailleplot/brailleparser/package-info.java @@ -1,4 +1,4 @@ /** - * This package contains all the requiered classes and interfaces for BrailleTableParsing. + * This package contains all the required classes and interfaces for BrailleTableParsing. */ package de.tudresden.inf.mci.brailleplot.brailleparser; \ No newline at end of file