Merge pull request #60 from informatik-ag-ngl/f/javadoc

Updated malformed Javadoc

src/main/java/envoy/client/Client.java

@@ -35,7 +35,7 @@ public class Client {
 
 	/**
 	 * Initializes the client. At this state, the client user has yet to be
-	 * initialized, which can be done by calling {@link Client#onlineInit(String).
+	 * initialized, which can be done by calling {@link Client#onlineInit(String)}.
 	 * 
 	 * @param config The {@link Config} instance to use in this client
 	 * @since Envoy v0.2-alpha

src/main/java/envoy/client/LocalDB.java

@@ -53,9 +53,10 @@ public class LocalDB {
 
 	/**
 	 * Constructs an empty local database. To serialize any chats to the file
-	 * system, call {@link LocalDB#initializeDBFile(File)}.
+	 * system, call {@link LocalDB#initializeDBFile()}.
 	 *
 	 * @param localDBDir the directory in which to store users and chats
+	 * @throws IOException if the LocalDB could not be initialised
 	 * @since Envoy v0.1-alpha
 	 */
 	public LocalDB(File localDBDir) throws IOException {

src/main/java/envoy/client/Settings.java

@@ -88,7 +88,7 @@ public class Settings {
 	/**
 	 * Updates the preferences when the save button is clicked.
 	 * 
-	 * @throws IOException if saving was not successful
+	 * @throws IOException if something went wrong while saving
 	 * @since Envoy v0.2-alpha
 	 */
 	public void save() throws IOException {
@@ -144,13 +144,15 @@ public class Settings {
 	public void setEnterToSend(boolean enterToSend) { this.enterToSend = enterToSend; }
 
 	/**
-	 * @return the map of all themes by name and colorContent
+	 * @return the map of all themes 
 	 * @since Envoy v0.2-alpha
 	 */
 	public Map<String, Theme> getThemes() { return themes; }
 
 	/**
-	 * @param themes the the the the
+	 * Sets the map of all themes
+	 * 
+	 * @param themes a map(String, Theme) of all themes
 	 * @since Envoy v0.2-alpha
 	 */
 	public void setThemes(Map<String, Theme> themes) { this.themes = themes; }

src/main/java/envoy/client/event/Event.java

@@ -6,7 +6,7 @@ package envoy.client.event;
  * Created: <strong>04.12.2019</strong><br>
  *
  * @author Kai S. K. Engelbart
- * @param <T> the type of our Event
+ * @param <T> the type of the Event
  * @since Envoy v0.2-alpha
  */
 public interface Event<T> {
@@ -16,3 +16,4 @@ public interface Event<T> {
 	 */
 	T get();
 }
+

src/main/java/envoy/client/ui/PrimaryScrollPane.java

@@ -27,7 +27,7 @@ public class PrimaryScrollPane extends JScrollPane {
 	/**
 	 * Styles the vertical and horizontal scroll bars.
 	 *
-	 * @param theme
+	 * @param theme the color set used to color the component
 	 * @since Envoy v0.2-alpha
 	 */
 	public void applyTheme(Theme theme) {

src/main/java/envoy/client/ui/PrimaryTextArea.java

@@ -22,7 +22,7 @@ public class PrimaryTextArea extends JTextArea {
 	/**
 	 * Creates the text area
 	 * 
-	 * @param borderSpace
+	 * @param borderSpace the space between components
 	 * @since Envoy 0.2-alpha
 	 */
 	public PrimaryTextArea(int borderSpace) { this(6, borderSpace); }