From 442bf79c69de1ea2f62242934eafb1f5dbea7d85 Mon Sep 17 00:00:00 2001 From: kske Date: Sat, 21 Dec 2019 00:43:38 +0100 Subject: [PATCH] Added missing Javadoc since tags as requested by @delvh --- src/main/java/envoy/client/Config.java | 1 + src/main/java/envoy/client/event/MessageEvent.java | 1 + src/main/java/envoy/client/event/ThemeChangeEvent.java | 2 ++ src/main/java/envoy/client/ui/ChatWindow.java | 1 + src/main/java/envoy/client/ui/Startup.java | 1 + src/main/java/envoy/client/ui/Theme.java | 2 ++ 6 files changed, 8 insertions(+) diff --git a/src/main/java/envoy/client/Config.java b/src/main/java/envoy/client/Config.java index e28dc92..ca86a33 100644 --- a/src/main/java/envoy/client/Config.java +++ b/src/main/java/envoy/client/Config.java @@ -31,6 +31,7 @@ public class Config { /** * @return the singleton instance of the {@link Config} + * @since Envoy v0.1-alpha */ public static Config getInstance() { if (config == null) config = new Config(); diff --git a/src/main/java/envoy/client/event/MessageEvent.java b/src/main/java/envoy/client/event/MessageEvent.java index 8eb7384..2e818e5 100644 --- a/src/main/java/envoy/client/event/MessageEvent.java +++ b/src/main/java/envoy/client/event/MessageEvent.java @@ -18,6 +18,7 @@ public class MessageEvent implements Event { * {@link Message} object. * * @param message the {@link Message} object to attach to this event + * @since Envoy v0.2-alpha */ public MessageEvent(Message message) { this.message = message; } diff --git a/src/main/java/envoy/client/event/ThemeChangeEvent.java b/src/main/java/envoy/client/event/ThemeChangeEvent.java index 84e6218..ac07aa1 100644 --- a/src/main/java/envoy/client/event/ThemeChangeEvent.java +++ b/src/main/java/envoy/client/event/ThemeChangeEvent.java @@ -8,6 +8,7 @@ import envoy.client.ui.Theme; * Created: 15 Dec 2019
* * @author Kai S. K. Engelbart + * @since Envoy v0.2-alpha */ public class ThemeChangeEvent implements Event { @@ -18,6 +19,7 @@ public class ThemeChangeEvent implements Event { * of the {@link Theme} currently in use * * @param theme the new currently used {@link Theme} object + * @since Envoy v0.2-alpha */ public ThemeChangeEvent(Theme theme) { this.theme = theme; } diff --git a/src/main/java/envoy/client/ui/ChatWindow.java b/src/main/java/envoy/client/ui/ChatWindow.java index ea8ab1e..b21e2d9 100644 --- a/src/main/java/envoy/client/ui/ChatWindow.java +++ b/src/main/java/envoy/client/ui/ChatWindow.java @@ -72,6 +72,7 @@ public class ChatWindow extends JFrame { * * @param client the {@link Client} used to send and receive messages * @param localDB the {@link LocalDB} used to manage stored messages and users + * @since Envoy v0.1-alpha */ public ChatWindow(Client client, LocalDB localDB) { this.client = client; diff --git a/src/main/java/envoy/client/ui/Startup.java b/src/main/java/envoy/client/ui/Startup.java index b226911..df07361 100644 --- a/src/main/java/envoy/client/ui/Startup.java +++ b/src/main/java/envoy/client/ui/Startup.java @@ -41,6 +41,7 @@ public class Startup { * * @param args the command line arguments may contain configuration parameters * and are parsed by the {@link Config} class + * @since Envoy v0.1-alpha */ public static void main(String[] args) { Config config = Config.getInstance(); diff --git a/src/main/java/envoy/client/ui/Theme.java b/src/main/java/envoy/client/ui/Theme.java index 78eccc6..bd2ccb3 100644 --- a/src/main/java/envoy/client/ui/Theme.java +++ b/src/main/java/envoy/client/ui/Theme.java @@ -41,6 +41,7 @@ public class Theme implements Serializable { * @param selectionColor the section color * @param typingMessageColor the color of currently typed messages * @param userNameColor the color of user names + * @since Envoy v0.2-alpha */ public Theme(String themeName, Color backgroundColor, Color cellColor, Color interactableForegroundColor, Color interactableBackgroundColor, Color messageColorChat, Color dateColorChat, Color selectionColor, Color typingMessageColor, Color userNameColor) { @@ -64,6 +65,7 @@ public class Theme implements Serializable { * * @param name the name of the {@link Theme} * @param other the {@link Theme} to copy + * @since Envoy v0.2-alpha */ public Theme(String name, Theme other) { this(name, other.backgroundColor, other.cellColor, other.interactableForegroundColor,