Updated malformed Javadoc

This commit is contained in:
delvh 2019-12-20 12:53:40 +01:00
parent d8cf751746
commit 1e1b078a37
7 changed files with 96 additions and 95 deletions

View File

@ -35,7 +35,7 @@ public class Client {
/** /**
* Initializes the client. At this state, the client user has yet to be * 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 * @param config The {@link Config} instance to use in this client
* @since Envoy v0.2-alpha * @since Envoy v0.2-alpha

View File

@ -52,9 +52,10 @@ public class LocalDB {
/** /**
* Constructs an empty local database. To serialize any chats to the file * 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 * @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 * @since Envoy v0.1-alpha
*/ */
public LocalDB(File localDBDir) throws IOException { public LocalDB(File localDBDir) throws IOException {

View File

@ -88,7 +88,7 @@ public class Settings {
/** /**
* Updates the preferences when the save button is clicked. * Updates the preferences when the save button is clicked.
* *
* @throws IOException * @throws IOException if something went wrong while saving
* @since Envoy v0.2-alpha * @since Envoy v0.2-alpha
*/ */
public void save() throws IOException { public void save() throws IOException {
@ -105,7 +105,7 @@ public class Settings {
/** /**
* adds new theme to the theme map and sets current theme to the new theme. * adds new theme to the theme map and sets current theme to the new theme.
* *
* @param theme * @param theme the theme to add
* @since Envoy v0.2-alpha * @since Envoy v0.2-alpha
*/ */
public void addNewThemeToMap(Theme theme) { public void addNewThemeToMap(Theme theme) {
@ -114,7 +114,7 @@ public class Settings {
} }
/** /**
* @return {@link currentTheme} * @return the name of the current Theme
* @since Envoy v0.2-alpha * @since Envoy v0.2-alpha
*/ */
public String getCurrentTheme() { return currentTheme; } public String getCurrentTheme() { return currentTheme; }
@ -122,7 +122,7 @@ public class Settings {
/** /**
* Sets the currentTheme * Sets the currentTheme
* *
* @param themeName * @param themeName the name of the current theme
* @since Envoy v0.2-alpha * @since Envoy v0.2-alpha
*/ */
public void setCurrentTheme(String themeName) { currentTheme = themeName; } public void setCurrentTheme(String themeName) { currentTheme = themeName; }
@ -144,15 +144,15 @@ public class Settings {
public void setEnterToSend(boolean enterToSend) { this.enterToSend = enterToSend; } public void setEnterToSend(boolean enterToSend) { this.enterToSend = enterToSend; }
/** /**
* @return {@link themes} map * @return the map of all themes
* @since Envoy v0.2-alpha * @since Envoy v0.2-alpha
*/ */
public Map<String, Theme> getThemes() { return themes; } public Map<String, Theme> getThemes() { return themes; }
/** /**
* Sets {@link themes} * Sets the map of all themes
* *
* @param themes * @param themes a map(String, Theme) of all themes
* @since Envoy v0.2-alpha * @since Envoy v0.2-alpha
*/ */
public void setThemes(Map<String, Theme> themes) { this.themes = themes; } public void setThemes(Map<String, Theme> themes) { this.themes = themes; }

View File

@ -6,6 +6,7 @@ package envoy.client.event;
* 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 the Event
* @since Envoy v0.2-alpha * @since Envoy v0.2-alpha
*/ */
public interface Event<T> { public interface Event<T> {

View File

@ -27,7 +27,7 @@ public class PrimaryScrollPane extends JScrollPane {
/** /**
* Styles the vertical and horizontal scroll bars. * Styles the vertical and horizontal scroll bars.
* *
* @param theme * @param theme the color set used to color the component
* @since Envoy v0.2-alpha * @since Envoy v0.2-alpha
*/ */
public void applyTheme(Theme theme) { public void applyTheme(Theme theme) {

View File

@ -22,7 +22,7 @@ public class PrimaryTextArea extends JTextArea {
/** /**
* 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); }

View File

@ -26,7 +26,6 @@ public class UserListRenderer extends JLabel implements ListCellRenderer<User> {
private static final long serialVersionUID = 5164417379767181198L; private static final long serialVersionUID = 5164417379767181198L;
@SuppressWarnings("incomplete-switch")
@Override @Override
public Component getListCellRendererComponent(JList<? extends User> list, User value, int index, boolean isSelected, boolean cellHasFocus) { public Component getListCellRendererComponent(JList<? extends User> list, User value, int index, boolean isSelected, boolean cellHasFocus) {
if (isSelected) { if (isSelected) {