javadoc fixes

MyRobotLab · Jan 16, 2024 · 1756d6e · 1756d6e
1 parent 84ebb1e
commit 1756d6e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/src/main/java/org/myrobotlab/net/Mail.java b/src/main/java/org/myrobotlab/net/Mail.java
@@ -167,13 +167,13 @@ public void setEmailServer(String host, Integer port) {
    * "Create and use App Passwords"
    * https://support.google.com/mail/answer/185833?hl=en
    * 
-   * @param host
-   * @param port
-   * @param userName
-   * @param password
-   * @param toAddress
-   * @param subject
-   * @param message
+   * @param host - smtp host
+   * @param port - smtp port
+   * @param userName - username
+   * @param password - password
+   * @param toAddress - address to sender
+   * @param subject - of email
+   * @param message - email body
    * @throws AddressException
    * @throws MessagingException
    */

diff --git a/src/main/java/org/myrobotlab/net/WsClient.java b/src/main/java/org/myrobotlab/net/WsClient.java
@@ -53,7 +53,7 @@ public WsClient() {
   /**
    * connect to a listening websocket e.g. connect("ws://localhost:8888")
    * 
-   * @param url
+   * @param url - url to connect to
    */
   public void connect(String url) {
     connect(null, url);

diff --git a/src/main/java/org/myrobotlab/service/ServoMixer.java b/src/main/java/org/myrobotlab/service/ServoMixer.java
@@ -264,7 +264,7 @@ public ServoMixer(String n, String id) {
    * Explicitly saving a new gesture file. This will error if the file already
    * exists. The gesture part moves will be empty.
    * 
-   * @param filename
+   * @param name - gesture name
    * @return
    */
   public String addNewGestureFile(String name) {