moorscode / stencil

classes/stencil.php

Doc Comments +1 added lines, -1 removed lines

@@ -172,7 +172,7 @@
 	 * Handler proxy function
 	 *
 	 * @param string $variable Name of the variable to set.
-	 * @param mixed  $value Value of the variable to set.
+	 * @param null|string  $value Value of the variable to set.
 	 *
 	 * @return mixed The value of the variable after it being set.
 	 */

classes/stencil/abstract-hierarchy.php

Doc Comments +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
 	/**
 	 * Set the options
 	 *
-	 * @param array $options Set the options available.
+	 * @param string[] $options Set the options available.
 	 */
 	protected function set_options( $options ) {
 		$this->options = $options;
@@ -55,7 +55,7 @@ 
 	/**
 	 * Return the key of the current element
 	 *
-	 * @return mixed|null scalar on success, null on failure.
+	 * @return integer scalar on success, null on failure.
 	 */
 	public function key() {
 		return $this->index;

classes/stencil/handler-factory-interface.php

Doc Comments +5 added lines

@@ -14,6 +14,7 @@ 
 	 *
 	 * @param string            $page Page to set.
 	 * @param array|Traversable $handler Handler to use.
+	 * @return void
 	 */
 	public static function set_hierarchy_handler( $page, $handler );
 
@@ -22,6 +23,7 @@ 
 	 *
 	 * @param string   $page Page to set.
 	 * @param callable $handler Handler to use.
+	 * @return void
 	 */
 	public static function set_page_type_handler( $page, $handler );
 
@@ -30,6 +32,7 @@ 
 	 *
 	 * @param string   $page Page to set to.
 	 * @param callable $handler Handler to use.
+	 * @return void
 	 */
 	public static function set_page_type_hooker( $page, $handler );
 
@@ -37,6 +40,7 @@ 
 	 * Remove handler for a page.
 	 *
 	 * @param string $page Page to remove from.
+	 * @return void
 	 */
 	public static function remove_page_type_handler( $page );
 
@@ -44,6 +48,7 @@ 
 	 * Remove page hooker from page
 	 *
 	 * @param string $page Page to remove from.
+	 * @return void
 	 */
 	public static function remove_page_type_hooker( $page );
 

classes/stencil/handler-interface.php

Doc Comments +2 added lines

@@ -25,6 +25,7 @@ 
 	 * Handler proxy functions
 	 *
 	 * @param Stencil_Recorder_Interface $recorder New Recorder to use.
+	 * @return void
 	 */
 	public function set_recorder( Stencil_Recorder_Interface $recorder );
 
@@ -43,6 +44,7 @@ 
 	 * Handler proxy functions
 	 *
 	 * @param string $variable Variable to Record into.
+	 * @return void
 	 */
 	public function start_recording( $variable );
 

classes/stencil/handler.php

Doc Comments +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
 	/**
 	 * Control loading the wp_head and wp_footer into variable
 	 *
-	 * @param bool|true $yes_or_no Wheter to load them or not.
+	 * @param boolean $yes_or_no Wheter to load them or not.
 	 */
 	public function load_wp_header_and_footer( $yes_or_no = true ) {
 		if ( $this->load_wp_header_and_footer === $yes_or_no ) {

classes/stencil/handlers-interface.php

Doc Comments +5 added lines

@@ -14,6 +14,7 @@ 
 	 *
 	 * @param string            $page Page to set.
 	 * @param array|Traversable $handler Handler to use.
+	 * @return void
 	 */
 	public function set_hierarchy_handler( $page, $handler );
 
@@ -22,6 +23,7 @@ 
 	 *
 	 * @param string   $page Page to set.
 	 * @param callable $handler Handler to use.
+	 * @return void
 	 */
 	public function set_page_type_handler( $page, $handler );
 
@@ -30,6 +32,7 @@ 
 	 *
 	 * @param string   $page Page to set to.
 	 * @param callable $handler Handler to use.
+	 * @return void
 	 */
 	public function set_page_type_hooker( $page, $handler );
 
@@ -37,6 +40,7 @@ 
 	 * Remove handler for a page.
 	 *
 	 * @param string $page Page to remove from.
+	 * @return void
 	 */
 	public function remove_page_type_handler( $page );
 
@@ -44,6 +48,7 @@ 
 	 * Remove page hooker from page
 	 *
 	 * @param string $page Page to remove from.
+	 * @return void
 	 */
 	public function remove_page_type_hooker( $page );
 }

classes/stencil/implementation-interface.php

Doc Comments +1 added lines

@@ -17,6 +17,7 @@
 	 * Uses fetch to fetch the output
 	 *
 	 * @param string $template Template file to show.
+	 * @return void
 	 */
 	public function display( $template );
 

classes/stencil/implementation.php

Doc Comments +1 added lines, -1 removed lines

@@ -113,7 +113,7 @@
 	/**
 	 * Get the template path
 	 *
-	 * @return string|array
+	 * @return string
 	 */
 	public function get_template_path() {
 		return $this->template_path;

classes/stencil/recorder-interface.php

Doc Comments +1 added lines

@@ -11,6 +11,7 @@
 interface Stencil_Recorder_Interface {
 	/**
 	 * Start capturing output buffer
+	 * @return void
 	 */
 	public function start_recording();