docs: added file summeries

Author: mxschmitt

src/API.class.php

@@ -1,14 +1,12 @@
 <?php
-/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
- *   file                 :  sinusbot.class.php
- *   version              :  1.0
- *   last modified        :  06. September 2018
- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
- *   author               :  Manuel Hettche
- *   copyright            :  (C) 2018 SinusBot
- *   email                :  info@ts3index.com
- *   begin                :  25. Juli 2015 *
- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+/**
+ * Class API | src/API.class.php
+ *
+ * Main class which will be used to connect to the SinusBot
+ *
+ * @package      SinusBot
+ * @author       Max Schmitt <max@schmitt.mx>
+ */
 
 namespace SinusBot;
 

src/Instance.class.php

@@ -1,4 +1,12 @@
 <?php
+/**
+ * Class Instance | src/Instance.class.php
+ *
+ * A single Instance with his available actions
+ *
+ * @package      SinusBot
+ * @author       Max Schmitt <max@schmitt.mx>
+ */
 
 namespace SinusBot;
 

src/Playlist.class.php

@@ -1,4 +1,12 @@
 <?php
+/**
+ * Class Playlist | src/Playlist.class.php
+ *
+ * A single Playlist with his available actions
+ *
+ * @package      SinusBot
+ * @author       Max Schmitt <max@schmitt.mx>
+ */
 
 namespace SinusBot;
 

src/RestClient.class.php

@@ -1,4 +1,12 @@
 <?php
+/**
+ * Class RestClient | src/RestClient.class.php
+ *
+ * RestClient is used to perform the http requests
+ *
+ * @package      SinusBot
+ * @author       Max Schmitt <max@schmitt.mx>
+ */
 
 namespace SinusBot;
 

src/autoload.php

@@ -1,4 +1,12 @@
 <?php
+/**
+ * Entrypoint Autoload | src/autoload.php
+ *
+ * Autoloader to use the SinusBot PHP Library
+ *
+ * @package      SinusBot
+ * @author       Max Schmitt <max@schmitt.mx>
+ */
 
 include_once("RestClient.class.php");
 include_once("Instance.class.php");