- improved documentation

FelixSFD · FelixSFD · commit f4723ba55b33 · 2017-03-13T22:22:15.000+01:00
diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>All Classes</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>All Classes</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/docs/constant-values.html b/docs/constant-values.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>Constant Field Values</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>Deprecated List</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/docs/help-doc.html b/docs/help-doc.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>API Help</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>A-Index</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>G-Index</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>O-Index</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>P-Index</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -85,9 +85,13 @@ <h2 class="title">P</h2>
 <dd>
 <div class="block">Initializes the object with the api key</div>
 </dd>
-<dt><span class="memberNameLink"><a href="../org/sobotics/PingService.html#PingService-java.lang.String-int-">PingService(String, int)</a></span> - Constructor for class org.sobotics.<a href="../org/sobotics/PingService.html" title="class in org.sobotics">PingService</a></dt>
+<dt><span class="memberNameLink"><a href="../org/sobotics/PingService.html#PingService-java.lang.String-java.lang.String-">PingService(String, String)</a></span> - Constructor for class org.sobotics.<a href="../org/sobotics/PingService.html" title="class in org.sobotics">PingService</a></dt>
 <dd>
-<div class="block">Initializes the object with a `pingInterval` in seconds and the api key</div>
+<div class="block">Initializes the object with the api key and bot-version</div>
+</dd>
+<dt><span class="memberNameLink"><a href="../org/sobotics/PingService.html#PingService-java.lang.String-java.lang.String-int-">PingService(String, String, int)</a></span> - Constructor for class org.sobotics.<a href="../org/sobotics/PingService.html" title="class in org.sobotics">PingService</a></dt>
+<dd>
+<div class="block">Initializes the object with a `pingInterval` in seconds, the bot's verision and the api key</div>
 </dd>
 </dl>
 <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">G</a>&nbsp;<a href="index-3.html">O</a>&nbsp;<a href="index-4.html">P</a>&nbsp;<a href="index-5.html">S</a>&nbsp;</div>
diff --git a/docs/index-files/index-5.html b/docs/index-files/index-5.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>S-Index</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
diff --git a/docs/index.html b/docs/index.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>Generated Documentation (Untitled)</title>
 <script type="text/javascript">
     targetPage = "" + window.location.search;
diff --git a/docs/org/sobotics/PingService.html b/docs/org/sobotics/PingService.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>PingService</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -166,9 +166,16 @@ <h3>Constructor Summary</h3>
 </td>
 </tr>
 <tr class="altColor">
-<td class="colOne"><code><span class="memberNameLink"><a href="../../org/sobotics/PingService.html#PingService-java.lang.String-int-">PingService</a></span>(java.lang.String&nbsp;key,
+<td class="colOne"><code><span class="memberNameLink"><a href="../../org/sobotics/PingService.html#PingService-java.lang.String-java.lang.String-">PingService</a></span>(java.lang.String&nbsp;key,
+           java.lang.String&nbsp;botVersion)</code>
+<div class="block">Initializes the object with the api key and bot-version</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../org/sobotics/PingService.html#PingService-java.lang.String-java.lang.String-int-">PingService</a></span>(java.lang.String&nbsp;key,
+           java.lang.String&nbsp;botVersion,
            int&nbsp;pingInterval)</code>
-<div class="block">Initializes the object with a `pingInterval` in seconds and the api key</div>
+<div class="block">Initializes the object with a `pingInterval` in seconds, the bot's verision and the api key</div>
 </td>
 </tr>
 </table>
@@ -272,17 +279,44 @@ <h4>PingService</h4>
 <h4>PingService</h4>
 <pre>public&nbsp;PingService(java.lang.String&nbsp;key)</pre>
 <div class="block">Initializes the object with the api key</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>key</code> - The API key for Redunda. You can get it form the instances overview</dd>
+</dl>
+</li>
+</ul>
+<a name="PingService-java.lang.String-java.lang.String-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>PingService</h4>
+<pre>public&nbsp;PingService(java.lang.String&nbsp;key,
+                   java.lang.String&nbsp;botVersion)</pre>
+<div class="block">Initializes the object with the api key and bot-version</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>key</code> - The API key for Redunda. You can get it form the instances overview</dd>
+<dd><code>botVersion</code> - The version of your bot as string</dd>
+</dl>
 </li>
 </ul>
-<a name="PingService-java.lang.String-int-">
+<a name="PingService-java.lang.String-java.lang.String-int-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>PingService</h4>
 <pre>public&nbsp;PingService(java.lang.String&nbsp;key,
+                   java.lang.String&nbsp;botVersion,
                    int&nbsp;pingInterval)</pre>
-<div class="block">Initializes the object with a `pingInterval` in seconds and the api key</div>
+<div class="block">Initializes the object with a `pingInterval` in seconds, the bot's verision and the api key</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>key</code> - The API key for Redunda. You can get it form the instances overview</dd>
+<dd><code>botVersion</code> - The version of your bot as string</dd>
+<dd><code>pingInterval</code> - The time in seconds between two pings. (30 by default)</dd>
+</dl>
 </li>
 </ul>
 </li>
@@ -300,7 +334,13 @@ <h3>Method Detail</h3>
 <li class="blockList">
 <h4>setDebugging</h4>
 <pre>public&nbsp;void&nbsp;setDebugging(boolean&nbsp;debug)</pre>
-<div class="block">Enables or disables the debugging mode.</div>
+<div class="block">Enables or disables the debugging mode.
+ 
+ If the debugging mode is activated, the bot will never be on standby.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>debug</code> - The new value</dd>
+</dl>
 </li>
 </ul>
 <a name="getDebugging--">
@@ -311,6 +351,10 @@ <h4>setDebugging</h4>
 <h4>getDebugging</h4>
 <pre>public&nbsp;boolean&nbsp;getDebugging()</pre>
 <div class="block">Returns is PingService is in debugging mode.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true, if debugging is enabled</dd>
+</dl>
 </li>
 </ul>
 <a name="start--">
diff --git a/docs/org/sobotics/class-use/PingService.html b/docs/org/sobotics/class-use/PingService.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>Uses of Class org.sobotics.PingService</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
diff --git a/docs/org/sobotics/package-frame.html b/docs/org/sobotics/package-frame.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>org.sobotics</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
diff --git a/docs/org/sobotics/package-summary.html b/docs/org/sobotics/package-summary.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>org.sobotics</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
diff --git a/docs/org/sobotics/package-tree.html b/docs/org/sobotics/package-tree.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>org.sobotics Class Hierarchy</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
diff --git a/docs/org/sobotics/package-use.html b/docs/org/sobotics/package-use.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>Uses of Package org.sobotics</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
diff --git a/docs/overview-tree.html b/docs/overview-tree.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 20:42:20 CET 2017 -->
+<!-- Generated by javadoc (1.8.0_102) on Mon Mar 13 22:21:47 CET 2017 -->
 <title>Class Hierarchy</title>
 <meta name="date" content="2017-03-13">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/src/main/java/org/sobotics/PingService.java b/src/main/java/org/sobotics/PingService.java
@@ -102,7 +102,7 @@ public void setDebugging(boolean debug) {
 	/**
 	 * Returns is PingService is in debugging mode.
 	 * 
-	 * @returns true, if debugging is enabled
+	 * @return true, if debugging is enabled
 	 * */
 	public boolean getDebugging() {
 		return this.debugging;
