diff --git a/src/TextOutput.java b/src/TextOutput.java index fe4dc90..6a94a63 100644 --- a/src/TextOutput.java +++ b/src/TextOutput.java @@ -109,6 +109,8 @@ public class TextOutput { /** * Method which sets the Variable formatRaw to true. + * + * @return true to indicate that it was successful. */ public boolean formatRaw() { formatRaw = true; @@ -119,7 +121,8 @@ public class TextOutput { * Method to set the formatRaw to false and also set the length of the desired paragraph length in order to limit * the paragraph length when printing the text. * - * @param length the maximum length of each paragraph that is allowed to be displayed when printing the text. + * @param length the paragraph length when printing the text. + * @return returns true if successful and false if and invalid length has been submitted. */ public boolean formatFix(int length) { if(length > 0) { @@ -133,15 +136,20 @@ public class TextOutput { } /** - * Methode um die Benutzerinformationen auszugeben. + * Method which outputs user information. * - * @param info Benutzerinformationen + * @param info User information received as a String. */ - public void UserInfoOutput(String info) { + public void userInfoOutput(String info) { System.out.println(info); } - public void IndexOutput(ArrayList index) { + /** + * Outputs the index that contains words with corresponding paragraphs. + * + * @param index ArrayList with words and in which part they have + */ + public void indexOutput(ArrayList index) { for (String word : index) { System.out.println(word); }