From a2d90ecc26734c7f795b3c14e0e063699316e08e Mon Sep 17 00:00:00 2001 From: Nilstrieb Date: Sun, 22 Nov 2020 15:00:21 +0100 Subject: [PATCH] update JavaDoc --- src/UMLField.java | 10 ++++++++++ src/UMLMethod.java | 14 ++++++++++++-- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/src/UMLField.java b/src/UMLField.java index da4e35d..1d81d4c 100644 --- a/src/UMLField.java +++ b/src/UMLField.java @@ -41,6 +41,11 @@ public class UMLField { } + /** + * Generate a Setter Method for this field + * + * @return The Setter Method as a String + */ public String setter() { String nameCapital = name.toUpperCase(); String nameCC = "set" + nameCapital.charAt(0) + name.substring(1); @@ -51,6 +56,11 @@ public class UMLField { return setter.toString(); } + /** + * Generate a Getter Method for this field + * + * @return The Getter Method as a String + */ public String getter() { String nameCapital = name.toUpperCase(); diff --git a/src/UMLMethod.java b/src/UMLMethod.java index 51f8ce8..53ffade 100644 --- a/src/UMLMethod.java +++ b/src/UMLMethod.java @@ -88,13 +88,23 @@ public class UMLMethod { return returnString.toString(); } + /** + * Add an argument to the method + * + * @param name The name of the variable + * @param dataType The type + */ public void addArg(String name, String dataType) { argsNames.add(name); argsTypes.add(dataType); } - public void addBodyLine(String line){ - if(methodBody.contains("\n")) { + /** + * Add a line to the method body + * @param line The line (not containing any linebreaks) + */ + public void addBodyLine(String line) { + if (methodBody.contains("\n")) { methodBody += "\n " + line; } else { methodBody += " " + line;