From bc230575f42dfd5167d7395730c1b215bc5a9da1 Mon Sep 17 00:00:00 2001 From: delvh Date: Fri, 26 Jun 2020 23:36:14 +0200 Subject: [PATCH] Cleaned up Envoy client: no more

, is now

...and some other funny mistakes found in Javadoc --- src/main/java/envoy/client/data/Chat.java | 6 +++--- src/main/java/envoy/client/data/ClientConfig.java | 4 ++-- src/main/java/envoy/client/data/LocalDB.java | 4 ++-- src/main/java/envoy/client/data/PersistentLocalDB.java | 4 ++-- src/main/java/envoy/client/data/Settings.java | 4 ++-- src/main/java/envoy/client/data/SettingsItem.java | 4 ++-- src/main/java/envoy/client/data/TransientLocalDB.java | 4 ++-- src/main/java/envoy/client/event/SendEvent.java | 1 - src/main/java/envoy/client/net/Client.java | 4 ++-- src/main/java/envoy/client/net/WriteProxy.java | 4 ++-- src/main/java/envoy/client/ui/IconUtil.java | 10 +++++----- .../java/envoy/client/ui/settings/package-info.java | 4 ++-- 12 files changed, 26 insertions(+), 27 deletions(-) diff --git a/src/main/java/envoy/client/data/Chat.java b/src/main/java/envoy/client/data/Chat.java index 022904c..7ca11ce 100644 --- a/src/main/java/envoy/client/data/Chat.java +++ b/src/main/java/envoy/client/data/Chat.java @@ -12,9 +12,9 @@ import envoy.data.Message.MessageStatus; import envoy.event.MessageStatusChange; /** - * Represents a chat between two {@link User}s
+ * Represents a chat between two {@link User}s * as a list of {@link Message} objects. - *
+ *

* Project: envoy-client
* File: Chat.java
* Created: 19 Oct 2019
@@ -32,7 +32,7 @@ public final class Chat implements Serializable { private static final long serialVersionUID = 1L; /** - * Provides the list of messages that the recipient receives.
+ * Provides the list of messages that the recipient receives.

* Saves the Messages in the corresponding chat at that Point. * * @param recipient the user who receives the messages diff --git a/src/main/java/envoy/client/data/ClientConfig.java b/src/main/java/envoy/client/data/ClientConfig.java index cde6b9a..a30dffb 100644 --- a/src/main/java/envoy/client/data/ClientConfig.java +++ b/src/main/java/envoy/client/data/ClientConfig.java @@ -11,8 +11,8 @@ import envoy.data.LoginCredentials; /** * Implements a configuration specific to the Envoy Client with default values - * and convenience methods.
- *
+ * and convenience methods. + *

* Project: envoy-client
* File: ClientConfig.java
* Created: 01.03.2020
diff --git a/src/main/java/envoy/client/data/LocalDB.java b/src/main/java/envoy/client/data/LocalDB.java index 66407fc..d8993f5 100644 --- a/src/main/java/envoy/client/data/LocalDB.java +++ b/src/main/java/envoy/client/data/LocalDB.java @@ -9,8 +9,8 @@ import envoy.event.NameChange; /** * Stores information about the current {@link User} and their {@link Chat}s. - * For message ID generation a {@link IDGenerator} is stored as well.
- *
+ * For message ID generation a {@link IDGenerator} is stored as well. + *

* Project: envoy-client
* File: LocalDB.java
* Created: 3 Feb 2020
diff --git a/src/main/java/envoy/client/data/PersistentLocalDB.java b/src/main/java/envoy/client/data/PersistentLocalDB.java index 5e13dd4..cc6cad9 100644 --- a/src/main/java/envoy/client/data/PersistentLocalDB.java +++ b/src/main/java/envoy/client/data/PersistentLocalDB.java @@ -11,8 +11,8 @@ import envoy.util.SerializationUtils; /** * Implements a {@link LocalDB} in a way that stores all information inside a - * folder on the local file system.
- *
+ * folder on the local file system. + *

* Project: envoy-client
* File: PersistentLocalDB.java
* Created: 27.10.2019
diff --git a/src/main/java/envoy/client/data/Settings.java b/src/main/java/envoy/client/data/Settings.java index c8bed6a..9d43bca 100644 --- a/src/main/java/envoy/client/data/Settings.java +++ b/src/main/java/envoy/client/data/Settings.java @@ -11,8 +11,8 @@ import envoy.util.SerializationUtils; /** * Manages all application settings, which are different objects that can be * changed during runtime and serialized them by using either the file system or - * the {@link Preferences} API.
- *
+ * the {@link Preferences} API. + *

* Project: envoy-client
* File: Settings.java
* Created: 11 Nov 2019
diff --git a/src/main/java/envoy/client/data/SettingsItem.java b/src/main/java/envoy/client/data/SettingsItem.java index 8638c05..d74e222 100644 --- a/src/main/java/envoy/client/data/SettingsItem.java +++ b/src/main/java/envoy/client/data/SettingsItem.java @@ -7,8 +7,8 @@ import javax.swing.JComponent; /** * Encapsulates a persistent value that is directly or indirectly mutable by the - * user.
- *
+ * user. + *

* Project: envoy-client
* File: SettingsItem.java
* Created: 23.12.2019
diff --git a/src/main/java/envoy/client/data/TransientLocalDB.java b/src/main/java/envoy/client/data/TransientLocalDB.java index ef592fb..5c7d2a6 100644 --- a/src/main/java/envoy/client/data/TransientLocalDB.java +++ b/src/main/java/envoy/client/data/TransientLocalDB.java @@ -2,8 +2,8 @@ package envoy.client.data; /** * Implements a {@link LocalDB} in a way that does not persist any information - * after application shutdown.
- *
+ * after application shutdown. + *

* Project: envoy-client
* File: TransientLocalDB.java
* Created: 3 Feb 2020
diff --git a/src/main/java/envoy/client/event/SendEvent.java b/src/main/java/envoy/client/event/SendEvent.java index e3c9f97..8ea650b 100644 --- a/src/main/java/envoy/client/event/SendEvent.java +++ b/src/main/java/envoy/client/event/SendEvent.java @@ -8,7 +8,6 @@ import envoy.event.Event; * Created: 11.02.2020
* * @author: Maximilian Käfer - * * @since Envoy Client v0.3-alpha */ public class SendEvent extends Event> { diff --git a/src/main/java/envoy/client/net/Client.java b/src/main/java/envoy/client/net/Client.java index 34384ec..5cf432a 100644 --- a/src/main/java/envoy/client/net/Client.java +++ b/src/main/java/envoy/client/net/Client.java @@ -20,8 +20,8 @@ import envoy.util.SerializationUtils; /** * Establishes a connection to the server, performs a handshake and delivers - * certain objects to the server.
- *
+ * certain objects to the server. + *

* Project: envoy-client
* File: Client.java
* Created: 28 Sep 2019
diff --git a/src/main/java/envoy/client/net/WriteProxy.java b/src/main/java/envoy/client/net/WriteProxy.java index 90e49e0..339f1f2 100644 --- a/src/main/java/envoy/client/net/WriteProxy.java +++ b/src/main/java/envoy/client/net/WriteProxy.java @@ -12,8 +12,8 @@ import envoy.util.EnvoyLog; /** * Implements methods to send {@link Message}s and * {@link MessageStatusChange}s to the server or cache them inside a - * {@link LocalDB} depending on the online status.
- *
+ * {@link LocalDB} depending on the online status. + *

* Project: envoy-client
* File: WriteProxy.java
* Created: 6 Feb 2020
diff --git a/src/main/java/envoy/client/ui/IconUtil.java b/src/main/java/envoy/client/ui/IconUtil.java index e2577ec..cdb99c5 100644 --- a/src/main/java/envoy/client/ui/IconUtil.java +++ b/src/main/java/envoy/client/ui/IconUtil.java @@ -8,11 +8,11 @@ import javafx.scene.image.Image; /** * Provides static utility methods for loading icons from the resource - * folder.
- *
- * Project: envoy-client - * File: IconUtil.java - * Created: 16.03.2020 + * folder. + *

+ * Project: envoy-client
+ * File: IconUtil.java
+ * Created: 16.03.2020
* * @author Kai S. K. Engelbart * @since Envoy Client v0.1-beta diff --git a/src/main/java/envoy/client/ui/settings/package-info.java b/src/main/java/envoy/client/ui/settings/package-info.java index f31317e..e908b93 100644 --- a/src/main/java/envoy/client/ui/settings/package-info.java +++ b/src/main/java/envoy/client/ui/settings/package-info.java @@ -1,7 +1,7 @@ /** * This package contains classes used for representing the settings - * visually.
- *
+ * visually. + *

* Project: envoy-client
* File: package-info.java
* Created: 19 Apr 2020