[TASK] Clean up phpDoc comments in t3lib_ajax
authorWouter Wolters <typo3@wouterwolters.nl>
Fri, 4 May 2012 18:47:37 +0000 (20:47 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Fri, 4 May 2012 22:24:35 +0000 (00:24 +0200)
* Provide correct parameter names in phpDoc
* Provide correct data types in phpDoc
* CGLify phpDoc (remove tabs)

Change-Id: I5f5a2c0522311a21d9e7faea3a5b71531c5044f2
Resolves: #36855
Releases: 6.0
Reviewed-on: http://review.typo3.org/11009
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
t3lib/class.t3lib_ajax.php

index f1cce78..1e5a633 100644 (file)
  * (1) generation of JavaScript code which creates an XMLHTTP object in a cross-browser manner
  * (2) generation of XML data as a reply
  *
- * @author     Sebastian Kurfürst <sebastian@garbage-group.de>
+ * @author Sebastian Kurfürst <sebastian@garbage-group.de>
  * @package TYPO3
  * @subpackage t3lib
  */
 class t3lib_ajax {
+
        /**
         * Gets the JavaScript code needed to handle an XMLHTTP request in the frontend.
         * All JS functions have to call ajax_doRequest(url) to make a request to the server.
         * USE:
         * See examples of using this function in template.php -> getContextMenuCode and alt_clickmenu.php -> printContent
         *
-        * @param       string          JS function handling the XML data from the server. That function gets the returned XML data as parameter.
-        * @param       string          JS fallback function which is called with the URL of the request in case ajax is not available.
-        * @param       boolean         If set to 1, the returned XML data is outputted as text in an alert window - useful for debugging, PHP errors are shown there, ...
-        * @return      string          JavaScript code needed to make and handle an XMLHTTP request
+        * @param string $handler Function JS function handling the XML data from the server. That function gets the returned XML data as parameter.
+        * @param string $fallback JS fallback function which is called with the URL of the request in case ajax is not available.
+        * @param boolean $debug If set to 1, the returned XML data is outputted as text in an alert window - useful for debugging, PHP errors are shown there, ...
+        * @return string JavaScript code needed to make and handle an XMLHTTP request
         */
        function getJScode($handlerFunction, $fallback = '', $debug = 0) {
                        // Init the XMLHTTP request object
@@ -75,7 +76,7 @@ class t3lib_ajax {
                        }
                        return A;
                }';
-                       // in case AJAX is not available, fallback function
+                       // In case AJAX is not available, fallback function
                if ($fallback) {
                        $fallback .= '(url)';
                } else {
@@ -111,8 +112,8 @@ class t3lib_ajax {
        /**
         * Function outputting XML data for TYPO3 ajax. The function directly outputs headers and content to the browser.
         *
-        * @param       string          $innerXML       XML data which will be sent to the browser
-        * @return      void
+        * @param string $innerXML XML data which will be sent to the browser
+        * @return void
         */
        function outputXMLreply($innerXML) {
                        // AJAX needs some XML data
@@ -121,7 +122,6 @@ class t3lib_ajax {
 <t3ajax>' . $innerXML . '</t3ajax>';
                echo $xml;
        }
-
 }
 
 ?>
\ No newline at end of file