[TASK] Clean-up PHPdoc comments in t3lib_PageRenderer
authorKai Vogel <kai.vogel@speedprogs.de>
Thu, 22 Mar 2012 19:01:09 +0000 (20:01 +0100)
committerOliver Hader <oliver@typo3.org>
Mon, 26 Mar 2012 17:23:19 +0000 (19:23 +0200)
Back-port of clean-up that was introduced with #27694.

Change-Id: I089c9e47ace839722a532e807949f86dde6917ec
Resolves: #35158
Related: #27694
Releases: 4.5
Reviewed-on: http://review.typo3.org/9814
Reviewed-by: Oliver Hader
Tested-by: Oliver Hader
t3lib/class.t3lib_pagerenderer.php

index 25dd3f5..c1906c1 100644 (file)
@@ -2,7 +2,7 @@
 /***************************************************************
  *  Copyright notice
  *
- *  (c) 2009-2011 Steffen Kamper (info@sk-typo3.de)
+ *  (c) 2009-2011 Steffen Kamper <info@sk-typo3.de>
  *  All rights reserved
  *
  *  This script is part of the TYPO3 project. The TYPO3 project is
  * TYPO3 pageRender class (new in TYPO3 4.3.0)
  * This class render the HTML of a webpage, usable for BE and FE
  *
- * @author     Steffen Kamper <info@sk-typo3.de>
+ * @author Steffen Kamper <info@sk-typo3.de>
  * @package TYPO3
  * @subpackage t3lib
- * $Id$
  */
 class t3lib_PageRenderer implements t3lib_Singleton {
 
@@ -456,7 +455,7 @@ class t3lib_PageRenderer implements t3lib_Singleton {
        }
 
        /**
-        * Enables concatenation of js/css files
+        * Enables concatenation of js and css files
         *
         * @param void
         * @return void
@@ -466,7 +465,7 @@ class t3lib_PageRenderer implements t3lib_Singleton {
        }
 
        /**
-        * Disables concatenation of js/css files
+        * Disables concatenation of js and css files
         *
         * @param void
         * @return void
@@ -646,7 +645,7 @@ class t3lib_PageRenderer implements t3lib_Singleton {
        }
 
        /**
-        * Gets concatenate of files
+        * Gets concatenate of js and css files
         *
         * @return boolean
         */
@@ -795,9 +794,9 @@ class t3lib_PageRenderer implements t3lib_Singleton {
        /**
         * Adds JS Library. JS Library block is rendered on top of the JS files.
         *
-        * @param string $name
-        * @param string $file
-        * @param string $type
+        * @param string $name Arbitrary identifier
+        * @param string $file File name
+        * @param string $type Content Type
         * @param boolean $compress             flag if library should be compressed
         * @param boolean $forceOnTop   flag if added library should be inserted at begin of this block
         * @param string $allWrap
@@ -823,9 +822,9 @@ class t3lib_PageRenderer implements t3lib_Singleton {
        /**
         * Adds JS Library to Footer. JS Library block is rendered on top of the Footer JS files.
         *
-        * @param string $name
-        * @param string $file
-        * @param string $type
+        * @param string $name Arbitrary identifier
+        * @param string $file File name
+        * @param string $type Content Type
         * @param boolean $compress     flag if library should be compressed
         * @param boolean $forceOnTop   flag if added library should be inserted at begin of this block
         * @param string $allWrap
@@ -851,8 +850,8 @@ class t3lib_PageRenderer implements t3lib_Singleton {
        /**
         * Adds JS file
         *
-        * @param string $file
-        * @param string $type
+        * @param string $file File name
+        * @param string $type Content Type
         * @param boolean $compress
         * @param boolean $forceOnTop
         * @param string $allWrap
@@ -879,8 +878,8 @@ class t3lib_PageRenderer implements t3lib_Singleton {
        /**
         * Adds JS file to footer
         *
-        * @param string $file
-        * @param string $type
+        * @param string $file File name
+        * @param string $type Content Type
         * @param boolean $compress
         * @param boolean $forceOnTop
         * @return void
@@ -1836,7 +1835,7 @@ class t3lib_PageRenderer implements t3lib_Singleton {
        /*****************************************************/
 
        /**
-        * concatenate files into one file
+        * Concatenate files into one file
         * registered handler
         *
         * @return void
@@ -1866,7 +1865,7 @@ class t3lib_PageRenderer implements t3lib_Singleton {
        }
 
        /**
-        * compress inline code
+        * Compresses inline code
         *
         * @return void
         */
@@ -1940,8 +1939,8 @@ class t3lib_PageRenderer implements t3lib_Singleton {
         *
         * Adds the version number for Frontend, compresses the file for Backend
         *
-        * @param       string  $filename               Filename
-        * @return      string          new filename
+        * @param string $filename Filename
+        * @return string New filename
         */
        protected function processJsFile($filename) {
                switch (TYPO3_MODE) {
@@ -1962,4 +1961,5 @@ class t3lib_PageRenderer implements t3lib_Singleton {
 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_pagerenderer.php'])) {
        include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_pagerenderer.php']);
 }
+
 ?>