Skip to content
Snippets Groups Projects
Commit 6b2945bc authored by Andrey Ruzhanskiy's avatar Andrey Ruzhanskiy
Browse files

Fixed typos in javadoc.

parent ecae7624
No related branches found
No related tags found
1 merge request!14Feat/braille print back end 4
package de.tudresden.inf.mci.brailleplot.brailleparser; 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 { public interface AbstractBrailleTableParser {
/** /**
* Common Method for querying the BrailleTable. * Common Method for querying the BrailleTable.
* @param key Braillecell, represented as String ("111000). * @param key Braille cell, represented as String ("111000).
* @return Byte, represented as int, corresponding to the given Braillecell. * @return Byte, represented as int, corresponding to the given Braille cell.
*/ */
int getValue(String key); int getValue(String key);
......
...@@ -9,7 +9,7 @@ public class JsonParser implements AbstractBrailleTableParser { ...@@ -9,7 +9,7 @@ public class JsonParser implements AbstractBrailleTableParser {
/** /**
* Currently not supported. * Currently not supported.
* @param filePath File path to the Brailletable. * @param filePath File path to the Braille table.
*/ */
public JsonParser(final String filePath) { public JsonParser(final String filePath) {
throw new UnsupportedOperationException(); throw new UnsupportedOperationException();
...@@ -18,8 +18,8 @@ public class JsonParser implements AbstractBrailleTableParser { ...@@ -18,8 +18,8 @@ public class JsonParser implements AbstractBrailleTableParser {
/** /**
* Currently not supported. * Currently not supported.
* @param key Braillecell, represented as String ("111000). * @param key Braille cell, represented as String ("111000).
* @return The Byte(int) representing the Braillecell specified in the BrailleTable. * @return The Byte(int) representing the Braille cell specified in the BrailleTable.
*/ */
@Override @Override
public int getValue(final String key) { public int getValue(final String key) {
......
...@@ -14,7 +14,7 @@ public class PropertiesParser implements AbstractBrailleTableParser { ...@@ -14,7 +14,7 @@ public class PropertiesParser implements AbstractBrailleTableParser {
private Properties mProperties = new Properties(); 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. * @param filePath The Path to the BrailleTable.
* @throws RuntimeException if the file Path does not exists. * @throws RuntimeException if the file Path does not exists.
*/ */
...@@ -33,9 +33,9 @@ public class PropertiesParser implements AbstractBrailleTableParser { ...@@ -33,9 +33,9 @@ public class PropertiesParser implements AbstractBrailleTableParser {
} }
/** /**
* Method for querying the Byte (represented via int) for a given Cell from the BrailleTable. * Method for querying the Byte (represented via int) for a given Cell from the braille table.
* @param key The Braillecell, represented as a String (for example "111000" for 6 BrailleCell). * @param key The Braille cell, represented as a String (for example "111000" for 6 BrailleCell).
* @return The Byte(int) representing the Braillecell specified in the BrailleTable, * @return The Byte(int) representing the Braille cell specified in the braille table,
*/ */
@Override @Override
public int getValue(final String key) { public int getValue(final String key) {
......
...@@ -21,8 +21,8 @@ public class XmlParser implements AbstractBrailleTableParser { ...@@ -21,8 +21,8 @@ public class XmlParser implements AbstractBrailleTableParser {
/** /**
* Currently not supported. * Currently not supported.
* @param key Braillecell, represented as String ("111000). * @param key braille cell, represented as String ("111000).
* @return The Byte(int) representing the Braillecell specified in the BrailleTable. * @return The Byte(int) representing the Braille cell specified in the braille table.
*/ */
@Override @Override
public int getValue(final String key) { public int getValue(final String key) {
......
/** /**
* 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; package de.tudresden.inf.mci.brailleplot.brailleparser;
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment