add docblocks to all files, classes, methods and variables
[bdrem.git] / src / bdrem / Autoloader.php
index 093b1b0..cebd0eb 100644 (file)
@@ -1,16 +1,51 @@
 <?php
+/**
+ * Part of bdrem
+ *
+ * PHP version 5
+ *
+ * @category  Tools
+ * @package   Bdrem
+ * @author    Christian Weiske <cweiske@cweiske.de>
+ * @copyright 2014 Christian Weiske
+ * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL v3
+ * @link      http://cweiske.de/bdrem.htm
+ */
 namespace bdrem;
 
+/**
+ * Class autoloader, PSR-0 compliant.
+ *
+ * @category  Tools
+ * @package   Bdrem
+ * @author    Christian Weiske <cweiske@cweiske.de>
+ * @copyright 2014 Christian Weiske
+ * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL v3
+ * @version   Release: @package_version@
+ * @link      http://cweiske.de/bdrem.htm
+ */
 class Autoloader
 {
+    /**
+     * Load the given class
+     *
+     * @param string $class Class name
+     *
+     * @return void
+     */
     public function load($class)
     {
         $file = strtr($class, '_\\', '//') . '.php';
         if (stream_resolve_include_path($file)) {
-            require $file;
+            include $file;
         }
     }
 
+    /**
+     * Register this autoloader
+     *
+     * @return void
+     */
     public static function register()
     {
         set_include_path(