Cleaned up Envoy client: no more <br><br>, is now <p>

...and some other funny mistakes found in Javadoc
This commit is contained in:
delvh 2020-06-26 23:36:14 +02:00
parent f61561d4b2
commit bc230575f4
12 changed files with 26 additions and 27 deletions

View File

@ -12,9 +12,9 @@ import envoy.data.Message.MessageStatus;
import envoy.event.MessageStatusChange;
/**
* Represents a chat between two {@link User}s <br>
* Represents a chat between two {@link User}s
* as a list of {@link Message} objects.
* <br>
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>Chat.java</strong><br>
* Created: <strong>19 Oct 2019</strong><br>
@ -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.<br>
* Provides the list of messages that the recipient receives.<p>
* Saves the Messages in the corresponding chat at that Point.
*
* @param recipient the user who receives the messages

View File

@ -11,8 +11,8 @@ import envoy.data.LoginCredentials;
/**
* Implements a configuration specific to the Envoy Client with default values
* and convenience methods.<br>
* <br>
* and convenience methods.
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>ClientConfig.java</strong><br>
* Created: <strong>01.03.2020</strong><br>

View File

@ -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.<br>
* <br>
* For message ID generation a {@link IDGenerator} is stored as well.
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>LocalDB.java</strong><br>
* Created: <strong>3 Feb 2020</strong><br>

View File

@ -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.<br>
* <br>
* folder on the local file system.
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>PersistentLocalDB.java</strong><br>
* Created: <strong>27.10.2019</strong><br>

View File

@ -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.<br>
* <br>
* the {@link Preferences} API.
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>Settings.java</strong><br>
* Created: <strong>11 Nov 2019</strong><br>

View File

@ -7,8 +7,8 @@ import javax.swing.JComponent;
/**
* Encapsulates a persistent value that is directly or indirectly mutable by the
* user.<br>
* <br>
* user.
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>SettingsItem.java</strong><br>
* Created: <strong>23.12.2019</strong><br>

View File

@ -2,8 +2,8 @@ package envoy.client.data;
/**
* Implements a {@link LocalDB} in a way that does not persist any information
* after application shutdown.<br>
* <br>
* after application shutdown.
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>TransientLocalDB.java</strong><br>
* Created: <strong>3 Feb 2020</strong><br>

View File

@ -8,7 +8,6 @@ import envoy.event.Event;
* Created: <strong>11.02.2020</strong><br>
*
* @author: Maximilian K&aumlfer
*
* @since Envoy Client v0.3-alpha
*/
public class SendEvent extends Event<Event<?>> {

View File

@ -20,8 +20,8 @@ import envoy.util.SerializationUtils;
/**
* Establishes a connection to the server, performs a handshake and delivers
* certain objects to the server.<br>
* <br>
* certain objects to the server.
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>Client.java</strong><br>
* Created: <strong>28 Sep 2019</strong><br>

View File

@ -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.<br>
* <br>
* {@link LocalDB} depending on the online status.
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>WriteProxy.java</strong><br>
* Created: <strong>6 Feb 2020</strong><br>

View File

@ -8,11 +8,11 @@ import javafx.scene.image.Image;
/**
* Provides static utility methods for loading icons from the resource
* folder.<br>
* <br>
* Project: <strong>envoy-client</strong>
* File: <strong>IconUtil.java</strong>
* Created: <strong>16.03.2020</strong>
* folder.
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>IconUtil.java</strong><br>
* Created: <strong>16.03.2020</strong><br>
*
* @author Kai S. K. Engelbart
* @since Envoy Client v0.1-beta

View File

@ -1,7 +1,7 @@
/**
* This package contains classes used for representing the settings
* visually.<br>
* <br>
* visually.
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>package-info.java</strong><br>
* Created: <strong>19 Apr 2020</strong><br>