Docblock corrections

phpbb-extensions · May 21, 2017 · 11e4cdb · 11e4cdb
1 parent e76510e
commit 11e4cdb
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 4 deletions.
diff --git a/controller/admin_controller.php b/controller/admin_controller.php
@@ -137,6 +137,7 @@ public function display_pages()
 	public function add_page()
 	{
 		// Initiate a page entity
+		/* @var $entity \phpbb\pages\entity\page */
 		$entity = $this->container->get('phpbb.pages.entity');
 
 		// Process the new page

diff --git a/controller/main_controller.php b/controller/main_controller.php
@@ -103,6 +103,7 @@ public function display($route)
 	protected function load_page_data($route)
 	{
 		// Initiate the page entity
+		/* @var $entity \phpbb\pages\entity\page */
 		$entity = $this->container->get('phpbb.pages.entity');
 
 		// Load the requested page by route

diff --git a/event/listener.php b/event/listener.php
@@ -119,6 +119,7 @@ public function show_page_links()
 				'ICON_LINK'  => !$row['page_icon_font'] ? $this->page_operator->get_page_icon($row['page_route']) : '',
 			));
 
+			// Set a boolean switch to enable the chosen template event
 			$this->template->assign_var('S_' . strtoupper($row['page_link_event_name']), true);
 		}
 	}

diff --git a/operators/page.php b/operators/page.php
@@ -98,6 +98,7 @@ public function get_pages()
 	*
 	* @param \phpbb\pages\entity\page_interface $entity Page entity with new data to insert
 	* @return \phpbb\pages\entity\page_interface Added page entity
+	* @throws \phpbb\pages\exception\out_of_bounds
 	* @access public
 	*/
 	public function add_page($entity)
@@ -164,8 +165,8 @@ public function get_page_routes()
 	}
 
 	/**
-	* Get custom page link icons (pages_*.gif)
-	* Added by the user to the core style/theme/images directores
+	* Get all custom page link icons (pages_*.gif)
+	* Added by the user to the core style/theme/images directories
 	*
 	* @return array Array of icon image paths
 	* @access public

diff --git a/operators/page_interface.php b/operators/page_interface.php
@@ -30,6 +30,7 @@ public function get_pages();
 	*
 	* @param \phpbb\pages\entity\page_interface $entity Page entity with new data to insert
 	* @return page_interface Added page entity
+	* @throws \phpbb\pages\exception\out_of_bounds
 	* @access public
 	*/
 	public function add_page($entity);
@@ -53,8 +54,8 @@ public function delete_page($page_id);
 	public function get_page_routes();
 
 	/**
-	* Get custom page link icons (pages_*.gif)
-	* Added by the user to the core style/theme/images directores
+	* Get all custom page link icons (pages_*.gif)
+	* Added by the user to the core style/theme/images directories
 	*
 	* @return array Array of icon image paths
 	* @access public