Added missing Javadoc since tags as requested by @delvh
This commit is contained in:
parent
ccff438c7f
commit
9234ab87ae
@ -31,6 +31,7 @@ public class Config {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return the singleton instance of the {@link Config}
|
* @return the singleton instance of the {@link Config}
|
||||||
|
* @since Envoy v0.1-alpha
|
||||||
*/
|
*/
|
||||||
public static Config getInstance() {
|
public static Config getInstance() {
|
||||||
if (config == null) config = new Config();
|
if (config == null) config = new Config();
|
||||||
|
@ -18,6 +18,7 @@ public class MessageEvent implements Event<Message> {
|
|||||||
* {@link Message} object.
|
* {@link Message} object.
|
||||||
*
|
*
|
||||||
* @param message the {@link Message} object to attach to this event
|
* @param message the {@link Message} object to attach to this event
|
||||||
|
* @since Envoy v0.2-alpha
|
||||||
*/
|
*/
|
||||||
public MessageEvent(Message message) { this.message = message; }
|
public MessageEvent(Message message) { this.message = message; }
|
||||||
|
|
||||||
|
@ -8,6 +8,7 @@ import envoy.client.ui.Theme;
|
|||||||
* Created: <strong>15 Dec 2019</strong><br>
|
* Created: <strong>15 Dec 2019</strong><br>
|
||||||
*
|
*
|
||||||
* @author Kai S. K. Engelbart
|
* @author Kai S. K. Engelbart
|
||||||
|
* @since Envoy v0.2-alpha
|
||||||
*/
|
*/
|
||||||
public class ThemeChangeEvent implements Event<Theme> {
|
public class ThemeChangeEvent implements Event<Theme> {
|
||||||
|
|
||||||
@ -18,6 +19,7 @@ public class ThemeChangeEvent implements Event<Theme> {
|
|||||||
* of the {@link Theme} currently in use
|
* of the {@link Theme} currently in use
|
||||||
*
|
*
|
||||||
* @param theme the new currently used {@link Theme} object
|
* @param theme the new currently used {@link Theme} object
|
||||||
|
* @since Envoy v0.2-alpha
|
||||||
*/
|
*/
|
||||||
public ThemeChangeEvent(Theme theme) { this.theme = theme; }
|
public ThemeChangeEvent(Theme theme) { this.theme = theme; }
|
||||||
|
|
||||||
|
@ -72,6 +72,7 @@ public class ChatWindow extends JFrame {
|
|||||||
*
|
*
|
||||||
* @param client the {@link Client} used to send and receive messages
|
* @param client the {@link Client} used to send and receive messages
|
||||||
* @param localDB the {@link LocalDB} used to manage stored messages and users
|
* @param localDB the {@link LocalDB} used to manage stored messages and users
|
||||||
|
* @since Envoy v0.1-alpha
|
||||||
*/
|
*/
|
||||||
public ChatWindow(Client client, LocalDB localDB) {
|
public ChatWindow(Client client, LocalDB localDB) {
|
||||||
this.client = client;
|
this.client = client;
|
||||||
|
@ -41,6 +41,7 @@ public class Startup {
|
|||||||
*
|
*
|
||||||
* @param args the command line arguments may contain configuration parameters
|
* @param args the command line arguments may contain configuration parameters
|
||||||
* and are parsed by the {@link Config} class
|
* and are parsed by the {@link Config} class
|
||||||
|
* @since Envoy v0.1-alpha
|
||||||
*/
|
*/
|
||||||
public static void main(String[] args) {
|
public static void main(String[] args) {
|
||||||
Config config = Config.getInstance();
|
Config config = Config.getInstance();
|
||||||
|
@ -41,6 +41,7 @@ public class Theme implements Serializable {
|
|||||||
* @param selectionColor the section color
|
* @param selectionColor the section color
|
||||||
* @param typingMessageColor the color of currently typed messages
|
* @param typingMessageColor the color of currently typed messages
|
||||||
* @param userNameColor the color of user names
|
* @param userNameColor the color of user names
|
||||||
|
* @since Envoy v0.2-alpha
|
||||||
*/
|
*/
|
||||||
public Theme(String themeName, Color backgroundColor, Color cellColor, Color interactableForegroundColor, Color interactableBackgroundColor,
|
public Theme(String themeName, Color backgroundColor, Color cellColor, Color interactableForegroundColor, Color interactableBackgroundColor,
|
||||||
Color messageColorChat, Color dateColorChat, Color selectionColor, Color typingMessageColor, Color userNameColor) {
|
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 name the name of the {@link Theme}
|
||||||
* @param other the {@link Theme} to copy
|
* @param other the {@link Theme} to copy
|
||||||
|
* @since Envoy v0.2-alpha
|
||||||
*/
|
*/
|
||||||
public Theme(String name, Theme other) {
|
public Theme(String name, Theme other) {
|
||||||
this(name, other.backgroundColor, other.cellColor, other.interactableForegroundColor,
|
this(name, other.backgroundColor, other.cellColor, other.interactableForegroundColor,
|
||||||
|
Reference in New Issue
Block a user