[ticket/11495] Fix comments and package docs

PHPBB3-11495
2025-03-14 04:30:29 +01:00 · 2013-04-25 22:39:24 +02:00 · 2013-04-25 22:39:24 +02:00 · baff4287e5
commit baff4287e5
parent 0def8b7d9c
9 changed files with 11 additions and 11 deletions
--- a/phpBB/includes/tree/interface.php
+++ b/phpBB/includes/tree/interface.php
@ -1,7 +1,7 @@
 <?php
 /**
 *
-* @package Tree
+* @package tree
 * @copyright (c) 2013 phpBB Group
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
@ -18,7 +18,7 @@ if (!defined('IN_PHPBB'))
 interface phpbb_tree_interface
 {
 	/**
-	* Insert an item into the tree
+	* Insert an item into the tree (also insert the rows into the table)
 	*
 	* @param array	$item	The item to be added
 	* @return array Array with item data as set in the database
@ -26,7 +26,7 @@ interface phpbb_tree_interface
 	public function insert(array $additional_data);

 	/**
-	* Delete an item from the tree
+	* Delete an item from the tree (also deletes the rows form the table)
 	*
 	* Also deletes all subitems from the tree
 	*
--- a/phpBB/includes/tree/nestedset.php
+++ b/phpBB/includes/tree/nestedset.php
@ -1,7 +1,7 @@
 <?php
 /**
 *
-* @package Tree - Nested Set
+* @package tree - nestedset
 * @copyright (c) 2013 phpBB Group
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
--- a/phpBB/includes/tree/nestedset_forum.php
+++ b/phpBB/includes/tree/nestedset_forum.php
@ -1,7 +1,7 @@
 <?php
 /**
 *
-* @package Tree - Nested Set Forum
+* @package tree - nestedset forum
 * @copyright (c) 2013 phpBB Group
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
--- a/tests/tree/nestedset_forum_base.php
+++ b/tests/tree/nestedset_forum_base.php
@ -1,7 +1,7 @@
 <?php
 /**
 *
-* @package Nested Set Forum
+* @package tree - nestedset forum
 * @copyright (c) 2013 phpBB Group
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
--- a/tests/tree/nestedset_forum_get_data_test.php
+++ b/tests/tree/nestedset_forum_get_data_test.php
@ -1,7 +1,7 @@
 <?php
 /**
 *
-* @package Nested Set Forum
+* @package tree - nestedset forum
 * @copyright (c) 2013 phpBB Group
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
--- a/tests/tree/nestedset_forum_insert_delete_test.php
+++ b/tests/tree/nestedset_forum_insert_delete_test.php
@ -1,7 +1,7 @@
 <?php
 /**
 *
-* @package Nested Set Forum
+* @package tree - nestedset forum
 * @copyright (c) 2013 phpBB Group
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
--- a/tests/tree/nestedset_forum_move_test.php
+++ b/tests/tree/nestedset_forum_move_test.php
@ -1,7 +1,7 @@
 <?php
 /**
 *
-* @package Nested Set Forum
+* @package tree - nestedset forum
 * @copyright (c) 2013 phpBB Group
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
--- a/tests/tree/nestedset_forum_regenerate_test.php
+++ b/tests/tree/nestedset_forum_regenerate_test.php
@ -1,7 +1,7 @@
 <?php
 /**
 *
-* @package Nested Set Forum
+* @package tree - nestedset forum
 * @copyright (c) 2013 phpBB Group
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *
--- a/tests/tree/nestedset_forum_test.php
+++ b/tests/tree/nestedset_forum_test.php
@ -1,7 +1,7 @@
 <?php
 /**
 *
-* @package Nested Set Forum
+* @package tree - nestedset forum
 * @copyright (c) 2013 phpBB Group
 * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
 *