doc: added missing phpdoc documentation

Author: mxschmitt

src/API.class.php

@@ -10,8 +10,17 @@
 
 namespace SinusBot;
 
+/**
+ * Class API
+ *
+ * API is the main class which will be used to connect to the SinusBot
+ */
 class API extends RestClient
 {
+  /**
+  * UUID stores the SinusBot Bot UUID
+  * @var string
+  */
     public $uuid = null;
 
   /**
@@ -403,7 +412,8 @@ public function getInstances()
   /**
   * createInstance
   *
-  * @param  string  $nickname  Nickname
+  * @param  string  $nickname  Name of the Bot
+  * @param  string  $backend   SinusBot backend (Discord or TS³)
   * @return array status
   */
     public function createInstance($nickname = "SinusBot MusicBot", $backend = "ts3")
@@ -452,9 +462,9 @@ public function getThumbnail($thumbnail)
   /**
   * __construct
   *
-  * @access private
-  * @param  string  $url    http://127.0.0.1:8087
-  * @param  string  $uuid  4852efdc-9705-4706-e469-cfvf77favf33
+  * @param  string  $url      SinusBot Bot URL
+  * @param  string  $uuid     SinusBot Bot UUID
+  * @param  string  $timeout  HTTP Timeout which is used to perform HTTP API requests
   * @return void
   */
     public function __construct($url = 'http://127.0.0.1:8087', $uuid = null, $timeout = 8000)

src/Instance.class.php

@@ -10,10 +10,32 @@
 
 namespace SinusBot;
 
+/**
+ * Class Instance
+ *
+ * Instance represents a single instance of the SinusBot
+ */
 class Instance extends RestClient
 {
+  /**
+  * UUID stores the SinusBot Instance UUID
+  * @var string
+  */
     public $uuid = null;
+  /**
+  * Instance holds the Instance array
+  * @var array
+  */
     public $instance = null;
+  /**
+  * __construct
+  *
+  * @param  string  $token    SinusBot auth token
+  * @param  string  $url      SinusBot Bot URL
+  * @param  int     $timeout  HTTP Timeout which is used to perform HTTP API requests
+  * @param  array   $instance SinusBot Instance array.
+  * @return void
+  */
     public function __construct($token, $url, $timeout, $instance)
     {
         $this->token = $token;
@@ -135,9 +157,8 @@ public function getVolume()
   /**
   * setVolume
   *
-  * @param  string  $volume        {0-100}
-  * @param  string  $instanceUUID  6421eedc-9705-4706-a269-cf6f38fa1a33
-  * @return array status
+  * @param  string  $volume  {0-100}
+  * @return array   status
   * @api
   */
     public function setVolume($volume = 50)
@@ -286,7 +307,7 @@ public function prependQueueTrack($trackUUID)
   * @param integer $trackPosition  first entry = 0
   * @return array status
   */
-    public function deleteQueueTrack($trackPosition, $instanceUUID)
+    public function deleteQueueTrack($trackPosition)
     {
         $currentTracks = $this->getQueueTracks();
         if ($currentTracks == null or !is_array($currentTracks)) {
@@ -327,9 +348,8 @@ public function say($text, $locale)
   /**
   * playTrack
   *
-  * @param  string  $trackUUID     6da519a3-5aa3-4f5e-9e2d-81c88e9159ea
-  * @param  string  $instanceUUID  6421eedc-9705-4706-a269-cf6f38fa1a33
-  * @return array status
+  * @param  string  $trackUUID   UUID of the track
+  * @return array   status
   */
     public function playTrack($trackUUID)
     {

src/Playlist.class.php

@@ -10,10 +10,32 @@
 
 namespace SinusBot;
 
+/**
+ * Playlist Instance
+ *
+ * Playlist represents a single Playlist of the SinusBot
+ */
 class Playlist extends RestClient
 {
+  /**
+  * Playlist holds the Playlist array
+  * @var array
+  */
     public $playlist = null;
+  /**
+  * UUID holds the Playlist UUID
+  * @var array
+  */
     public $uuid = null;
+  /**
+  * __construct
+  *
+  * @param  string  $token    SinusBot auth token
+  * @param  string  $url      SinusBot Bot URL
+  * @param  int     $timeout  HTTP Timeout which is used to perform HTTP API requests
+  * @param  array   $playlist SinusBot Playlist array.
+  * @return void
+  */
     public function __construct($token, $url, $timeout, $playlist)
     {
         $this->token = $token;

src/RestClient.class.php

@@ -10,10 +10,27 @@
 
 namespace SinusBot;
 
+/**
+ * Class RestClient
+ *
+ * RestClient is used to perform the http requests to the SinusBot API
+ */
 class RestClient
 {
+  /**
+  * Timeout represents the HTTP timeout when HTTP requests to the SinusBot API are performed
+  * @var int
+  */
     protected $timeout = null;
+  /**
+  * Token is the SinusBot auth token which will be there temporary stored.
+  * @var string
+  */    
     protected $token = null;
+  /**
+  * URL is the SinusBot URL with the port and the HTTP protocol
+  * @var string
+  */   
     protected $url = null;
   /**
   * request executes a request to the SinusBot API