Fixed Javadoc formatting and spelling
This commit is contained in:
		| @@ -52,57 +52,56 @@ public class Config { | |||||||
| 				case "--localDB": | 				case "--localDB": | ||||||
| 				case "-db": | 				case "-db": | ||||||
| 					localDB = new File(args[++i]); | 					localDB = new File(args[++i]); | ||||||
| 					break; |  | ||||||
| 			} | 			} | ||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	/** | 	/** | ||||||
| 	 * @return {@code true} if server, port andd localDB directory are known. | 	 * @return {@code true} if server, port and localDB directory are known. | ||||||
| 	 * @since Envoy v0.1-alpha | 	 * @since Envoy v0.1-alpha | ||||||
| 	 */ | 	 */ | ||||||
| 	public boolean isInitialized() { return server != null && !server.isEmpty() && port > 0 && port < 65566 && localDB != null; } | 	public boolean isInitialized() { return server != null && !server.isEmpty() && port > 0 && port < 65566 && localDB != null; } | ||||||
|  |  | ||||||
| 	/** | 	/** | ||||||
| 	 * @return the URL of our website | 	 * @return the host name of the Envoy server | ||||||
| 	 * @since Envoy v0.1-alpha | 	 * @since Envoy v0.1-alpha | ||||||
| 	 */ | 	 */ | ||||||
| 	public String getServer() { return server; } | 	public String getServer() { return server; } | ||||||
|  |  | ||||||
| 	/** | 	/** | ||||||
| 	 * Changes the default URL. | 	 * Changes the default server host name. | ||||||
| 	 * Exclusively meant for developing reasons. (localhost) | 	 * Exclusively intended for development purposes. | ||||||
| 	 *  | 	 *  | ||||||
| 	 * @param server the URL where wish to host Envoy | 	 * @param server the host name of the Envoy server | ||||||
| 	 * @since Envoy v0.1-alpha | 	 * @since Envoy v0.1-alpha | ||||||
| 	 */ | 	 */ | ||||||
| 	public void setServer(String server) { this.server = server; } | 	public void setServer(String server) { this.server = server; } | ||||||
|  |  | ||||||
| 	/** | 	/** | ||||||
| 	 * @return the port at which Envoy is located in the Server | 	 * @return the port at which the Envoy server is located on the host | ||||||
| 	 * @since Envoy v0.1-alpha | 	 * @since Envoy v0.1-alpha | ||||||
| 	 */ | 	 */ | ||||||
| 	public int getPort() { return port; } | 	public int getPort() { return port; } | ||||||
|  |  | ||||||
| 	/** | 	/** | ||||||
| 	 * Changes the default port. | 	 * Changes the default port. | ||||||
| 	 * Exclusively meant for developing reasons. (localhost) | 	 * Exclusively intended for development purposes. | ||||||
| 	 *  | 	 *  | ||||||
| 	 * @param port the port where we wish to connect to {@code Envoy}. | 	 * @param port the port where an Envoy server is located | ||||||
| 	 * @since Envoy v0.1-alpha | 	 * @since Envoy v0.1-alpha | ||||||
| 	 */ | 	 */ | ||||||
| 	public void setPort(int port) { this.port = port; } | 	public void setPort(int port) { this.port = port; } | ||||||
|  |  | ||||||
| 	/** | 	/** | ||||||
| 	*@return the current local database that is held for that user | 	 * @return the local database specific to the client user | ||||||
| 	 * @since Envoy v0.1-alpha | 	 * @since Envoy v0.1-alpha | ||||||
| 	 **/ | 	 **/ | ||||||
| 	public File getLocalDB() { return localDB; } | 	public File getLocalDB() { return localDB; } | ||||||
|  |  | ||||||
| 	/** | 	/** | ||||||
| 	 * Changes the default local database. | 	 * Changes the default local database. | ||||||
| 	*Exclusively meant for developing reasons. | 	 * Exclusively intended for development purposes. | ||||||
| 	 * | 	 * | ||||||
| 	*@param the local database object to set | 	 * @param the file containing the local database | ||||||
| 	 * @since Envoy v0.1-alpha | 	 * @since Envoy v0.1-alpha | ||||||
| 	 **/ | 	 **/ | ||||||
| 	public void setLocalDB(File localDB) { this.localDB = localDB; } | 	public void setLocalDB(File localDB) { this.localDB = localDB; } | ||||||
|   | |||||||
| @@ -29,14 +29,14 @@ public class LocalDB { | |||||||
| 	/** | 	/** | ||||||
| 	 * Constructs an empty local database. | 	 * Constructs an empty local database. | ||||||
| 	 * | 	 * | ||||||
| 	*@param sender the user who logs in | 	 * @param sender the user that is logged in with this client | ||||||
| 	 * @since Envoy v0.1-alpha | 	 * @since Envoy v0.1-alpha | ||||||
| 	 **/ | 	 **/ | ||||||
| 	public LocalDB(User sender) { this.sender = sender; } | 	public LocalDB(User sender) { this.sender = sender; } | ||||||
|  |  | ||||||
| 	/** | 	/** | ||||||
| 	*Initialises the local database and fills it with values | 	 * Initializes the local database and fills it with values | ||||||
| 	*if the user already sent/ received a message.<br> | 	 * if the user has already sent or received messages. | ||||||
| 	 * | 	 * | ||||||
| 	 * @param localDBDir the directory where we wish to save/load the database from. | 	 * @param localDBDir the directory where we wish to save/load the database from. | ||||||
| 	 * @throws EnvoyException if the directory selected is not an actual directory. | 	 * @throws EnvoyException if the directory selected is not an actual directory. | ||||||
| @@ -72,7 +72,7 @@ public class LocalDB { | |||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	/** | 	/** | ||||||
| 	*Loads all chats saved by Envoy for the user.<br> | 	 * Loads all chats saved by Envoy for the client user. | ||||||
| 	 * | 	 * | ||||||
| 	 * @throws EnvoyException if something fails while loading. | 	 * @throws EnvoyException if something fails while loading. | ||||||
| 	 * @since Envoy v0.1-alpha | 	 * @since Envoy v0.1-alpha | ||||||
| @@ -88,7 +88,8 @@ public class LocalDB { | |||||||
| 	} | 	} | ||||||
|  |  | ||||||
| 	/** | 	/** | ||||||
| 	*@return all chats that the user has saved | 	 * @return all saves {@link Chat} objects that list the client user as the | ||||||
|  | 	 *         sender | ||||||
| 	 * @since Envoy v0.1-alpha | 	 * @since Envoy v0.1-alpha | ||||||
| 	 **/ | 	 **/ | ||||||
| 	public List<Chat> getChats() { return chats; } | 	public List<Chat> getChats() { return chats; } | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user