From 38ddeb2a520b3cac7fdf6be746c97b6f3ed6d710 Mon Sep 17 00:00:00 2001
From: flashwave <me@flash.moe>
Date: Wed, 3 Feb 2016 23:22:56 +0100
Subject: [PATCH] Added more PHPDoc stuff

---
 libraries/ActionCode.php                |  6 ++++++
 libraries/BBcode.php                    |  6 ++++++
 libraries/BBcodeDefinitions/Align.php   |  6 ++++++
 libraries/BBcodeDefinitions/Code.php    |  6 ++++++
 libraries/BBcodeDefinitions/Lists.php   |  6 ++++++
 libraries/BBcodeDefinitions/Size.php    |  6 ++++++
 libraries/BBcodeDefinitions/User.php    | 22 ++++++++++++++++++++--
 libraries/BBcodeDefinitions/YouTube.php |  6 ++++++
 libraries/Bans.php                      |  6 ++++++
 libraries/CSRF.php                      |  6 ++++++
 libraries/Comments.php                  |  6 ++++++
 libraries/Config.php                    |  6 ++++++
 libraries/Console/Application.php       |  6 ++++++
 libraries/Controllers/Forum.php         |  6 ++++++
 libraries/Controllers/Meta.php          |  6 ++++++
 libraries/DBWrapper/mysql.php           |  6 ++++++
 libraries/Database.php                  |  6 ++++++
 libraries/File.php                      |  6 ++++++
 libraries/Forum/Forum.php               | 12 +++++++++++-
 libraries/Forum/Post.php                |  6 ++++++
 libraries/Forum/Thread.php              |  6 ++++++
 libraries/Hashing.php                   |  4 +++-
 libraries/News.php                      |  6 ++++++
 libraries/Payments.php                  |  6 ++++++
 libraries/Perms.php                     |  6 ++++++
 libraries/Perms/Forum.php               |  6 ++++++
 libraries/Perms/Manage.php              |  6 ++++++
 libraries/Perms/Site.php                |  6 ++++++
 libraries/Rank.php                      |  6 ++++++
 libraries/Router.php                    |  6 ++++++
 libraries/Session.php                   |  6 ++++++
 libraries/Template.php                  |  6 ++++++
 libraries/Trick.php                     |  6 ++++++
 libraries/Urls.php                      |  6 ++++++
 libraries/User.php                      |  6 ++++++
 libraries/Users.php                     |  6 ++++++
 libraries/Utils.php                     |  6 ++++++
 libraries/Whois.php                     |  4 +++-
 38 files changed, 241 insertions(+), 5 deletions(-)

diff --git a/libraries/ActionCode.php b/libraries/ActionCode.php
index f9ae1aa..de4d430 100644
--- a/libraries/ActionCode.php
+++ b/libraries/ActionCode.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the action code handling class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 /**
diff --git a/libraries/BBcode.php b/libraries/BBcode.php
index 395fd7f..e3e54cf 100644
--- a/libraries/BBcode.php
+++ b/libraries/BBcode.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the BBcode handler.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 use JBBCode\Parser;
diff --git a/libraries/BBcodeDefinitions/Align.php b/libraries/BBcodeDefinitions/Align.php
index 1fb171a..e2e1f50 100644
--- a/libraries/BBcodeDefinitions/Align.php
+++ b/libraries/BBcodeDefinitions/Align.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the text alignment bbcode class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\BBcodeDefinitions;
 
 use JBBCode\Parser;
diff --git a/libraries/BBcodeDefinitions/Code.php b/libraries/BBcodeDefinitions/Code.php
index 247c572..314b24b 100644
--- a/libraries/BBcodeDefinitions/Code.php
+++ b/libraries/BBcodeDefinitions/Code.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the code format bbcode class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\BBcodeDefinitions;
 
 use JBBCode\Parser;
diff --git a/libraries/BBcodeDefinitions/Lists.php b/libraries/BBcodeDefinitions/Lists.php
index 1a6829c..7356051 100644
--- a/libraries/BBcodeDefinitions/Lists.php
+++ b/libraries/BBcodeDefinitions/Lists.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the list bbcode class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\BBcodeDefinitions;
 
 use JBBCode\Parser;
diff --git a/libraries/BBcodeDefinitions/Size.php b/libraries/BBcodeDefinitions/Size.php
index 8ac1982..0960f46 100644
--- a/libraries/BBcodeDefinitions/Size.php
+++ b/libraries/BBcodeDefinitions/Size.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the font size bbcode class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\BBcodeDefinitions;
 
 use JBBCode\Parser;
diff --git a/libraries/BBcodeDefinitions/User.php b/libraries/BBcodeDefinitions/User.php
index 6fb052e..4e38aa7 100644
--- a/libraries/BBcodeDefinitions/User.php
+++ b/libraries/BBcodeDefinitions/User.php
@@ -1,6 +1,8 @@
 <?php
-/*
- * User bbcode
+/**
+ * Holds the username linking bbcode class.
+ * 
+ * @package Sakura
  */
 
 namespace Sakura\BBcodeDefinitions;
@@ -9,8 +11,17 @@ use JBBCode\Parser;
 use JBBCode\CodeDefinition;
 use JBBCode\ElementNode;
 
+/**
+ * Username BBcode for JBBCode.
+ * 
+ * @package Sakura
+ * @author Julian van de Groep <me@flash.moe>
+ */
 class User extends CodeDefinition
 {
+    /**
+     * Constructor.
+     */
     public function __construct()
     {
         parent::__construct();
@@ -19,6 +30,13 @@ class User extends CodeDefinition
         $this->setParseContent(false);
     }
 
+    /**
+     * Compiles the user bbcode to HTML
+     * 
+     * @param ElementNode $el The JBBCode element node.
+     * 
+     * @return string The compiled HTML.
+     */
     public function asHtml(ElementNode $el)
     {
         $content = "";
diff --git a/libraries/BBcodeDefinitions/YouTube.php b/libraries/BBcodeDefinitions/YouTube.php
index 3ade16b..2975e48 100644
--- a/libraries/BBcodeDefinitions/YouTube.php
+++ b/libraries/BBcodeDefinitions/YouTube.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the YouTube embed bbcode class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\BBcodeDefinitions;
 
 use JBBCode\Parser;
diff --git a/libraries/Bans.php b/libraries/Bans.php
index a9d45d6..f47fba6 100644
--- a/libraries/Bans.php
+++ b/libraries/Bans.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the ban manager.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 /**
diff --git a/libraries/CSRF.php b/libraries/CSRF.php
index 98669fd..bef5bf4 100644
--- a/libraries/CSRF.php
+++ b/libraries/CSRF.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the CSRF token handler.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 use Sakura\Hashing;
diff --git a/libraries/Comments.php b/libraries/Comments.php
index 9978369..63444f3 100644
--- a/libraries/Comments.php
+++ b/libraries/Comments.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the holds the comment handler class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 /**
diff --git a/libraries/Config.php b/libraries/Config.php
index cae303b..d416832 100644
--- a/libraries/Config.php
+++ b/libraries/Config.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the configuration manager.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 /**
diff --git a/libraries/Console/Application.php b/libraries/Console/Application.php
index 1550fff..1f7d56f 100644
--- a/libraries/Console/Application.php
+++ b/libraries/Console/Application.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the console application meta.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\Console;
 
 /**
diff --git a/libraries/Controllers/Forum.php b/libraries/Controllers/Forum.php
index 5a5a86b..a742953 100644
--- a/libraries/Controllers/Forum.php
+++ b/libraries/Controllers/Forum.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the forum pages controllers.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\Controllers;
 
 use Sakura\Config;
diff --git a/libraries/Controllers/Meta.php b/libraries/Controllers/Meta.php
index 3c286a7..1ff4e54 100644
--- a/libraries/Controllers/Meta.php
+++ b/libraries/Controllers/Meta.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the meta page controllers.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\Controllers;
 
 use Sakura\Config;
diff --git a/libraries/DBWrapper/mysql.php b/libraries/DBWrapper/mysql.php
index 1769b24..a61911b 100644
--- a/libraries/DBWrapper/mysql.php
+++ b/libraries/DBWrapper/mysql.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the MySQL/PDO wrapper.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\DBWrapper;
 
 use PDO;
diff --git a/libraries/Database.php b/libraries/Database.php
index 046f20c..6c00583 100644
--- a/libraries/Database.php
+++ b/libraries/Database.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the database wrapper interfacer.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 /**
diff --git a/libraries/File.php b/libraries/File.php
index 8e802f7..f144dcf 100644
--- a/libraries/File.php
+++ b/libraries/File.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the file server.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 use finfo;
diff --git a/libraries/Forum/Forum.php b/libraries/Forum/Forum.php
index f5c3a70..389961d 100644
--- a/libraries/Forum/Forum.php
+++ b/libraries/Forum/Forum.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the forum object class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\Forum;
 
 use Sakura\Database;
@@ -157,7 +163,11 @@ class Forum
         return $raw ? $perm : $this->_permissions->check($flag, $perm);
     }
 
-    // Subforums
+    /**
+     * Gets all subforums of this forum.
+     * 
+     * @return array Array containing forum objects.
+     */
     public function forums()
     {
         // Check if _forums is populated
diff --git a/libraries/Forum/Post.php b/libraries/Forum/Post.php
index 52cde73..3828993 100644
--- a/libraries/Forum/Post.php
+++ b/libraries/Forum/Post.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the post object class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\Forum;
 
 use Sakura\Utils;
diff --git a/libraries/Forum/Thread.php b/libraries/Forum/Thread.php
index f064199..49c0f76 100644
--- a/libraries/Forum/Thread.php
+++ b/libraries/Forum/Thread.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the thread object class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\Forum;
 
 use Sakura\Database;
diff --git a/libraries/Hashing.php b/libraries/Hashing.php
index 102f142..07bc049 100644
--- a/libraries/Hashing.php
+++ b/libraries/Hashing.php
@@ -1,5 +1,5 @@
 <?php
-/*
+/**
  * Password Hashing With PBKDF2 (https://defuse.ca/php-pbkdf2.htm).
  * Copyright (c) 2013, Taylor Hornby
  * All rights reserved.
@@ -25,6 +25,8 @@
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * @package Sakura
  */
 
 namespace Sakura;
diff --git a/libraries/News.php b/libraries/News.php
index c0630ac..c07e63c 100644
--- a/libraries/News.php
+++ b/libraries/News.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the news handler.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 /**
diff --git a/libraries/Payments.php b/libraries/Payments.php
index 8be8757..57a0e55 100644
--- a/libraries/Payments.php
+++ b/libraries/Payments.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the payments handler.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 use \PayPal\Api\Amount;
diff --git a/libraries/Perms.php b/libraries/Perms.php
index 8c82ba0..47ac097 100644
--- a/libraries/Perms.php
+++ b/libraries/Perms.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the global permissions handler.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 /**
diff --git a/libraries/Perms/Forum.php b/libraries/Perms/Forum.php
index aeb5df1..14f1410 100644
--- a/libraries/Perms/Forum.php
+++ b/libraries/Perms/Forum.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the forum permission flags.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\Perms;
 
 /**
diff --git a/libraries/Perms/Manage.php b/libraries/Perms/Manage.php
index 96e17e7..071881e 100644
--- a/libraries/Perms/Manage.php
+++ b/libraries/Perms/Manage.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the site management permission flags.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\Perms;
 
 /**
diff --git a/libraries/Perms/Site.php b/libraries/Perms/Site.php
index e3454e8..984ab5e 100644
--- a/libraries/Perms/Site.php
+++ b/libraries/Perms/Site.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the global site permission flags.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura\Perms;
 
 /**
diff --git a/libraries/Rank.php b/libraries/Rank.php
index 8004b80..340e705 100644
--- a/libraries/Rank.php
+++ b/libraries/Rank.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the rank object class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 use Sakura\Perms;
diff --git a/libraries/Router.php b/libraries/Router.php
index a223ae9..b47773b 100644
--- a/libraries/Router.php
+++ b/libraries/Router.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the router class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 use Phroute\Phroute\RouteCollector;
diff --git a/libraries/Session.php b/libraries/Session.php
index fff5c02..bbcf324 100644
--- a/libraries/Session.php
+++ b/libraries/Session.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the session handler.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 /**
diff --git a/libraries/Template.php b/libraries/Template.php
index b245572..e0e3a31 100644
--- a/libraries/Template.php
+++ b/libraries/Template.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the templating engine class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 use Twig_Environment;
diff --git a/libraries/Trick.php b/libraries/Trick.php
index a3e5350..e0f76e4 100644
--- a/libraries/Trick.php
+++ b/libraries/Trick.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the extension manager.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 /**
diff --git a/libraries/Urls.php b/libraries/Urls.php
index 5ffe66b..2d08f16 100644
--- a/libraries/Urls.php
+++ b/libraries/Urls.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the url generation class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 /**
diff --git a/libraries/User.php b/libraries/User.php
index ea28177..55be46b 100644
--- a/libraries/User.php
+++ b/libraries/User.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds the user object class.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 use Sakura\Perms;
diff --git a/libraries/Users.php b/libraries/Users.php
index 589072c..827765d 100644
--- a/libraries/Users.php
+++ b/libraries/Users.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds various functions to interface with users.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 use Sakura\Perms\Site;
diff --git a/libraries/Utils.php b/libraries/Utils.php
index fa4b965..e13fa9c 100644
--- a/libraries/Utils.php
+++ b/libraries/Utils.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Holds various utility functions.
+ * 
+ * @package Sakura
+ */
+
 namespace Sakura;
 
 use PHPMailer;
diff --git a/libraries/Whois.php b/libraries/Whois.php
index 6a4f55d..a0f3056 100644
--- a/libraries/Whois.php
+++ b/libraries/Whois.php
@@ -1,5 +1,5 @@
 <?php
-/*
+/**
  * Whois in PHP (featuring a very original name), adjusted for Sakura
  * By Flashwave <http://flash.moe>
  * Released under the MIT-License
@@ -25,6 +25,8 @@
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
+ * 
+ * @package Sakura
  */
 
 namespace Sakura;