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

@@ -1,18 +1,19 @@
-package envoy.client.event;
+package envoy.client.event;
-
+
-/**
+/**
- * Project: <strong>envoy-client</strong><br>
+ * Project: <strong>envoy-client</strong><br>
- * File: <strong>Event.java</strong><br>
+ * File: <strong>Event.java</strong><br>
- * Created: <strong>04.12.2019</strong><br>
+ * Created: <strong>04.12.2019</strong><br>
- *
+ *
- * @author Kai S. K. Engelbart
+ * @author Kai S. K. Engelbart
- * @param <T> the type of our Event
+ * @param <T> the type of the Event
- * @since Envoy v0.2-alpha
+ * @since Envoy v0.2-alpha
- */
+ */
-public interface Event<T> {
+public interface Event<T> {
-
+
-	/**
+	/**
-	 * @return the data associated with this event
+	 * @return the data associated with this event
-	 */
+	 */
-	T get();
+	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

@@ -1,67 +1,67 @@
-package envoy.client.ui;
+package envoy.client.ui;
-
+
-import java.awt.Font;
+import java.awt.Font;
-import java.awt.Graphics;
+import java.awt.Graphics;
-
+
-import javax.swing.JTextArea;
+import javax.swing.JTextArea;
-import javax.swing.border.EmptyBorder;
+import javax.swing.border.EmptyBorder;
-
+
-/**
+/**
- * Project: <strong>envoy-client</strong><br>
+ * Project: <strong>envoy-client</strong><br>
- * File: <strong>PrimaryTextArea.javaEvent.java</strong><br>
+ * File: <strong>PrimaryTextArea.javaEvent.java</strong><br>
- * Created: <strong>07.12.2019</strong><br>
+ * Created: <strong>07.12.2019</strong><br>
- * 
+ * 
- * @author Maximilian K&auml;fer
+ * @author Maximilian K&auml;fer
- * @since Envoy v0.2-alpha
+ * @since Envoy v0.2-alpha
- */
+ */
-public class PrimaryTextArea extends JTextArea {
+public class PrimaryTextArea extends JTextArea {
-
+
-	private static final long	serialVersionUID	= -5829028696155434913L;
+	private static final long	serialVersionUID	= -5829028696155434913L;
-	private int					arcSize;
+	private int					arcSize;
-
+
-	/**
+	/**
-	 * Creates the text area
+	 * Creates the text area
-	 * 
+	 * 
-	 * @param borderSpace
+	 * @param borderSpace the space between components
-	 * @since Envoy 0.2-alpha
+	 * @since Envoy 0.2-alpha
-	 */
+	 */
-	public PrimaryTextArea(int borderSpace) { this(6, borderSpace); }
+	public PrimaryTextArea(int borderSpace) { this(6, borderSpace); }
-
+
-	/**
+	/**
-	 * Creates the text area
+	 * Creates the text area
-	 * 
+	 * 
-	 * @param arcSize     is the diameter of the arc at the four corners.
+	 * @param arcSize     is the diameter of the arc at the four corners.
-	 * @param borderSpace is the insets of the border on all four sides.
+	 * @param borderSpace is the insets of the border on all four sides.
-	 * @since Envoy 0.2-alpha
+	 * @since Envoy 0.2-alpha
-	 */
+	 */
-	public PrimaryTextArea(int arcSize, int borderSpace) {
+	public PrimaryTextArea(int arcSize, int borderSpace) {
-		super();
+		super();
-		setWrapStyleWord(true);
+		setWrapStyleWord(true);
-		setLineWrap(true);
+		setLineWrap(true);
-		setBorder(null);
+		setBorder(null);
-		setFont(new Font("Arial", Font.PLAIN, 17));
+		setFont(new Font("Arial", Font.PLAIN, 17));
-		setBorder(new EmptyBorder(borderSpace, borderSpace, borderSpace, borderSpace));
+		setBorder(new EmptyBorder(borderSpace, borderSpace, borderSpace, borderSpace));
-		setOpaque(false);
+		setOpaque(false);
-
+
-		this.arcSize = arcSize;
+		this.arcSize = arcSize;
-	}
+	}
-
+
-	@Override
+	@Override
-	protected void paintComponent(Graphics g) {
+	protected void paintComponent(Graphics g) {
-		g.setColor(getBackground());
+		g.setColor(getBackground());
-		g.fillRoundRect(0, 0, getWidth(), getHeight(), arcSize, arcSize);
+		g.fillRoundRect(0, 0, getWidth(), getHeight(), arcSize, arcSize);
-		super.paintComponent(g);
+		super.paintComponent(g);
-	}
+	}
-
+
-	/**
+	/**
-	 * @return the arcSize - the diameter of the arc at the four corners.
+	 * @return the arcSize - the diameter of the arc at the four corners.
-	 * @since Envoy 0.2-alpha
+	 * @since Envoy 0.2-alpha
-	 */
+	 */
-	public int getArcSize() { return arcSize; }
+	public int getArcSize() { return arcSize; }
-
+
-	/**
+	/**
-	 * @param arcSize the arcSize to set
+	 * @param arcSize the arcSize to set
-	 * @since Envoy 0.2-alpha
+	 * @since Envoy 0.2-alpha
-	 */
+	 */
-	public void setArcSize(int arcSize) { this.arcSize = arcSize; }
+	public void setArcSize(int arcSize) { this.arcSize = arcSize; }
-}
+}