fixes in javadoc
authorVictor Kirhenshtein <victor@netxms.org>
Wed, 8 Jun 2016 17:54:21 +0000 (20:54 +0300)
committerVictor Kirhenshtein <victor@netxms.org>
Wed, 8 Jun 2016 17:54:21 +0000 (20:54 +0300)
src/java/client/mobile-agent/src/main/java/org/netxms/mobile/agent/DciPushData.java
src/java/client/mobile-agent/src/main/java/org/netxms/mobile/agent/Session.java

index b44b2f1..5b0ff84 100644 (file)
@@ -1,6 +1,6 @@
 /**
  * NetXMS - open source network management system
- * Copyright (C) 2003-2012 Victor Kirhenshtein
+ * Copyright (C) 2003-2016 Victor Kirhenshtein
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -30,9 +30,9 @@ public class DciPushData
        public String value;
        
        /**
-        * @param nodeId
-        * @param dciId
-        * @param value
+        * @param nodeId node object ID
+        * @param dciId DCI ID
+        * @param value value to push
         */
        public DciPushData(long nodeId, long dciId, String value)
        {
@@ -44,9 +44,9 @@ public class DciPushData
        }
 
        /**
-        * @param nodeName
-        * @param dciName
-        * @param value
+        * @param nodeName node object name
+        * @param dciName DCI name
+        * @param value value to push
         */
        public DciPushData(String nodeName, String dciName, String value)
        {
index c6edd62..c9aff38 100644 (file)
@@ -271,10 +271,10 @@ public class Session
        /**
         * Wait for message with specific code and id.
         * 
-        * @param code
-        * @param id
+        * @param code message code
+        * @param id message ID
         * @return Message object
-        * @throws MobileAgentException
+    * @throws MobileAgentException if server returns an error or request was timed out
         */
        public NXCPMessage waitForMessage(final int code, final long id) throws MobileAgentException
        {
@@ -287,9 +287,9 @@ public class Session
        /**
         * Wait for CMD_REQUEST_COMPLETED message with given id using default timeout
         * 
-        * @param id
-        * @return
-        * @throws MobileAgentException
+        * @param id message ID
+        * @return received message
+    * @throws MobileAgentException if server returns an error or request was timed out
         */
        public NXCPMessage waitForRCC(final long id) throws MobileAgentException
        {
@@ -297,10 +297,12 @@ public class Session
        }
 
        /**
-        * @param id
-        * @param timeout
-        * @return
-        * @throws NXCException
+        * Wait for request completion message.
+        * 
+        * @param id message ID
+        * @param timeout timeout (milliseconds)
+        * @return received message
+        * @throws MobileAgentException if server returns an error or request was timed out
         */
        public NXCPMessage waitForRCC(final long id, final int timeout) throws MobileAgentException
        {
@@ -330,7 +332,7 @@ public class Session
         * @param command
         *           Command code
         * @throws IOException
-        * @throws MobileAgentException
+    * @throws MobileAgentException if server returns an error or request was timed out
         */
        protected void executeSimpleCommand(int command) throws IOException, MobileAgentException
        {
@@ -344,7 +346,7 @@ public class Session
         * 
         * @throws IOException
         * @throws UnknownHostException
-        * @throws MobileAgentException
+    * @throws MobileAgentException if server returns an error or request was timed out
         */
        public void connect() throws IOException, UnknownHostException, MobileAgentException
        {