Updated PhpDocs for Plugin::__construct(), View::__construct(), View:…

…:get() and View::render()
joechilds · Jun 18, 2013 · effd5c5 · effd5c5
1 parent da93023
commit effd5c5
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/Swiftlet/Plugin.php b/Swiftlet/Plugin.php
@@ -14,9 +14,9 @@ abstract class Plugin implements Interfaces\Plugin
 
 	/**
 	 * Constructor
-	 * @param object $app
-	 * @param object $view
-	 * @param object $controller
+	 * @param Interfaces\App $app
+	 * @param Interfaces\View $view
+	 * @param Interfaces\Controller $controller
 	 */
 	public function __construct(Interfaces\App $app, Interfaces\View $view, Interfaces\Controller $controller)
 	{

diff --git a/Swiftlet/View.php b/Swiftlet/View.php
@@ -17,7 +17,7 @@ class View implements Interfaces\View
 
 	/**
 	 * Constructor
-	 * @param object $app
+	 * @param Interfaces\App $app
 	 * @param string $name
 	 */
 	public function __construct(Interfaces\App $app, $name)
@@ -28,11 +28,11 @@ public function __construct(Interfaces\App $app, $name)
 
 	/**
 	 * Get a view variable
-	 * @params string $variable
-	 * @params bool $htmlEncode
-	 * @return mixed
+	 * @param string $variable
+	 * @param bool $htmlEncode
+	 * @return mixed|null
 	 */
-	public function get($variable, $htmlEncode = true)
+    public function get($variable, $htmlEncode = true)
 	{
 		if ( isset($this->variables[$variable]) ) {
 			if ( $htmlEncode ) {
@@ -131,6 +131,8 @@ public function htmlDecode($value)
 
 	/**
 	 * Render the view
+	 *
+	 * @throws \Exception
 	 */
 	public function render()
 	{