[TASK] Clean up phpDoc comments in t3lib classes
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_pagetree.php
index b35f73d..9406455 100644 (file)
  *
  * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- * @coauthor   René Fritz <r.fritz@colorcube.de>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @coauthor René Fritz <r.fritz@colorcube.de>
  */
 
-
 /**
  * Class for generating a page tree.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- * @coauthor   René Fritz <r.fritz@colorcube.de>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @coauthor René Fritz <r.fritz@colorcube.de>
  * @see t3lib_treeView, t3lib_browseTree
  * @package TYPO3
  * @subpackage t3lib
@@ -61,7 +60,7 @@ class t3lib_pageTree extends t3lib_treeView {
         * REMEMBER to feed a $clause which will filter out non-readable pages!
         *
         * @param string $clause Part of where query which will filter out non-readable pages.
-        * @param string $orderByFields record ORDER BY field
+        * @param string $orderByFields Record ORDER BY field
         * @return void
         */
        function init($clause = '', $orderByFields = '') {
@@ -87,8 +86,8 @@ class t3lib_pageTree extends t3lib_treeView {
        /**
         * Returns TRUE/FALSE if the next level for $id should be expanded - and all levels should, so we always return 1.
         *
-        * @param       integer         ID (uid) to test for (see extending classes where this is checked againts session data)
-        * @return      boolean
+        * @param integer $id ID (uid) to test for (see extending classes where this is checked againts session data)
+        * @return boolean
         */
        function expandNext($id) {
                return 1;
@@ -98,12 +97,12 @@ class t3lib_pageTree extends t3lib_treeView {
         * Generate the plus/minus icon for the browsable tree.
         * In this case, there is no plus-minus icon displayed.
         *
-        * @param       array           record for the entry
-        * @param       integer         The current entry number
-        * @param       integer         The total number of entries. If equal to $a, a 'bottom' element is returned.
-        * @param       integer         The number of sub-elements to the current element.
-        * @param       boolean         The element was expanded to render subelements if this flag is set.
-        * @return      string          Image tag with the plus/minus icon.
+        * @param array $row Record for the entry
+        * @param integer $a The current entry number
+        * @param integer $c The total number of entries. If equal to $a, a 'bottom' element is returned.
+        * @param integer $nextCount The number of sub-elements to the current element.
+        * @param boolean $exp The element was expanded to render subelements if this flag is set.
+        * @return string Image tag with the plus/minus icon.
         * @access private
         * @see t3lib_treeView::PMicon()
         */
@@ -115,12 +114,11 @@ class t3lib_pageTree extends t3lib_treeView {
                return $icon;
        }
 
-
        /**
         * Get stored tree structure AND updating it if needed according to incoming PM GET var.
         * - Here we just set it to nothing since we want to just render the tree, nothing more.
         *
-        * @return      void
+        * @return void
         * @access private
         */
        function initializePositionSaving() {