PHPDoc inline documentation

Swiftlet/App.php

@@ -2,6 +2,20 @@
 
 namespace Swiftlet;
 
+/**
+ * Application class
+ *
+ * @property string $action
+ * @property array $args
+ * @property array $config
+ * @property Interfaces\Controller $controller
+ * @property string $controllerName
+ * @property array $hooks
+ * @property array $plugins
+ * @property string $rootPath
+ * @property array $singletons
+ * @property Interfaces\View $view
+ */
 class App implements Interfaces\App
 {
  protected

Swiftlet/Controller.php

@@ -2,6 +2,14 @@
 
 namespace Swiftlet;
 
+/**
+ * Controller class
+ *
+ * @abstract
+ * @property Interfaces\App $app
+ * @property Interfaces\View $view
+ * @property string $title
+ */
 abstract class Controller implements Interfaces\Controller
 {
  protected
@@ -12,6 +20,7 @@ abstract class Controller implements Interfaces\Controller
 
  /**
  * Constructor
+ *
  * @param Interfaces\App $app
  * @param Interfaces\View $view
  */

Swiftlet/Controllers/Error404.php

@@ -2,6 +2,11 @@
 
 namespace Swiftlet\Controllers;
 
+/**
+ * Error 404 controller
+ *
+ * @property $title
+ */
 class Error404 extends \Swiftlet\Controller
 {
  protected

Swiftlet/Controllers/Index.php

@@ -2,6 +2,11 @@
 
 namespace Swiftlet\Controllers;
 
+/**
+ * Index controller
+ *
+ * @property $title
+ */
 class Index extends \Swiftlet\Controller
 {
  protected

Swiftlet/Exception.php

@@ -2,5 +2,8 @@
 
 namespace Swiftlet;
 
+/**
+ * Exception class
+ */
 class Exception extends \Exception
 { }

Swiftlet/Interfaces/App.php

@@ -2,6 +2,9 @@
 
 namespace Swiftlet\Interfaces;
 
+/**
+ * Application interface
+ */
 interface App
 {
  public function run();

Swiftlet/Interfaces/Controller.php

@@ -2,6 +2,9 @@
 
 namespace Swiftlet\Interfaces;
 
+/**
+ * Controller interface
+ */
 interface Controller
 {
  public function __construct(App $app, View $view);

Swiftlet/Interfaces/Model.php

@@ -2,6 +2,9 @@
 
 namespace Swiftlet\Interfaces;
 
+/**
+ * Model interface
+ */
 interface Model
 {
  public function __construct(App $app);

Swiftlet/Interfaces/Plugin.php

@@ -2,6 +2,9 @@
 
 namespace Swiftlet\Interfaces;
 
+/**
+ * Plugin interface
+ */
 interface Plugin
 {
  public function __construct(App $app, View $view, Controller $controller);

Swiftlet/Interfaces/View.php

@@ -2,6 +2,9 @@
 
 namespace Swiftlet\Interfaces;
 
+/**
+ * View interface
+ */
 interface View
 {
  public function __construct(App $app, $name);

Swiftlet/Model.php

@@ -2,6 +2,12 @@
 
 namespace Swiftlet;
 
+/**
+ * Model class
+ *
+ * @abstract
+ * @property Interfaces\App $app
+ */
 abstract class Model implements Interfaces\Model
 {
  protected
@@ -10,6 +16,7 @@ abstract class Model implements Interfaces\Model
 
  /**
  * Constructor
+ *
  * @param Interfaces\App $app
  */
  public function __construct(Interfaces\App $app)

Swiftlet/Models/Example.php

@@ -2,10 +2,14 @@
 
 namespace Swiftlet\Models;
 
+/**
+ * Example model
+ */
 class Example extends \Swiftlet\Model
 {
  /**
  * Example method. This could be anything, really...
+ *
  * @return string
  */
  public function getHelloWorld()

Swiftlet/Plugin.php

@@ -2,6 +2,14 @@
 
 namespace Swiftlet;
 
+/**
+ * Plugin class
+ *
+ * @abstract
+ * @property Interfaces\App $app
+ * @property Interfaces\Controller $controller
+ * @property Interfaces\View $view
+ */
 abstract class Plugin implements Interfaces\Plugin
 {
  protected

Swiftlet/Plugins/Example.php

@@ -2,6 +2,9 @@
 
 namespace Swiftlet\Plugins;
 
+/**
+ * Example plugin
+ */
 class Example extends \Swiftlet\Plugin
 {
  /**

Swiftlet/View.php

@@ -2,6 +2,13 @@
 
 namespace Swiftlet;
 
+/**
+ * View class
+ *
+ * @property Interfaces\App $app
+ * @property array $variables
+ * @name array $name
+ */
 class View implements Interfaces\View
 {
  protected