[TASK] Fix dummy parameter and return texts in phpDoc 50/35550/3
authorWouter Wolters <typo3@wouterwolters.nl>
Wed, 17 Dec 2014 20:58:50 +0000 (21:58 +0100)
committerChristian Kuhn <lolli@schwarzbu.ch>
Thu, 18 Dec 2014 18:06:07 +0000 (19:06 +0100)
Resolves: #63969
Releases: master
Change-Id: If6559f99998ad9f188b40466830556db507d9eda
Reviewed-on: http://review.typo3.org/35550
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
typo3/sysext/core/Classes/DataHandling/DataHandler.php
typo3/sysext/indexed_search/Classes/Utility/DoubleMetaPhoneUtility.php
typo3/sysext/rtehtmlarea/Classes/Controller/ParseHtmlController.php
typo3/sysext/rtehtmlarea/Classes/Controller/UserElementsController.php
typo3/sysext/rtehtmlarea/Classes/RteHtmlAreaBase.php

index 7450b25..2e78fd8 100644 (file)
@@ -1504,14 +1504,14 @@ class DataHandler {
         * @param string $value The value to set.
         * @param array $tcaFieldConf Field configuration from $GLOBALS['TCA']
         * @param string $table Table name
-        * @param int $id Return UID
-        * @param [type] $curValue
-        * @param [type] $status
+        * @param int $id UID of record
+        * @param mixed $curValue Current value of the field
+        * @param string $status 'update' or 'new' flag
         * @param int $realPid The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted. If $realPid is -1 it means that a new version of the record is being inserted.
-        * @param [type] $recFID
+        * @param string $recFID Field identifier [table:uid:field] for flexforms
         * @param string $field Field name. Must NOT be set if the call is for a flexform field (since flexforms are not allowed within flexforms).
-        * @param [type] $uploadedFiles
-        * @param [type] $tscPID
+        * @param array $uploadedFiles
+        * @param int $tscPID TSconfig PID
         * @param array $additionalData Additional data to be forwarded to sub-processors
         * @return array Returns the evaluated $value as key "value" in this array.
         */
index f1a9e44..0b19635 100644 (file)
@@ -802,9 +802,9 @@ class DoubleMetaPhoneUtility {
        /**
         * Is vowel?
         *
-        * @param       [type]          $string: ...
-        * @param       [type]          $pos: ...
-        * @return      [type]          ...
+        * @param string $string
+        * @param int $pos
+        * @return bool|int
         */
        public function IsVowel($string, $pos) {
                return preg_match('/[AEIOUY]/', substr($string, $pos, 1));
@@ -813,8 +813,8 @@ class DoubleMetaPhoneUtility {
        /**
         * Is slavogermanic?
         *
-        * @param       [type]          $string: ...
-        * @return      [type]          ...
+        * @param string $string
+        * @return bool|int
         */
        public function SlavoGermanic($string) {
                return preg_match('/W|K|CZ|WITZ/', $string);
index 0bd3b4c..24c5388 100644 (file)
@@ -51,7 +51,7 @@ class ParseHtmlController {
        public $prefixId = 'TYPO3HtmlParser';
 
        /**
-        * @return      [type]          ...
+        * @return void
         */
        public function init() {
                $this->doc = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Template\DocumentTemplate::class);
@@ -68,7 +68,7 @@ class ParseHtmlController {
        /**
         * Main function
         *
-        * @return      [type]          ...
+        * @return void
         */
        public function main() {
                $this->content .= $this->main_parse_html($this->modData['openKeys']);
@@ -78,7 +78,7 @@ class ParseHtmlController {
        /**
         * Print content
         *
-        * @return      [type]          ...
+        * @return void
         */
        public function printContent() {
                echo $this->content;
@@ -87,8 +87,8 @@ class ParseHtmlController {
        /**
         * Rich Text Editor (RTE) html parser
         *
-        * @param       [type]          $openKeys: ...
-        * @return      [type]          ...
+        * @param array $openKeys Unused
+        * @return string
         */
        public function main_parse_html($openKeys) {
                $editorNo = GeneralUtility::_GP('editorNo');
index 26911ce..10cb8e9 100644 (file)
@@ -61,7 +61,7 @@ class UserElementsController {
        }
 
        /**
-        * @return      [type]          ...
+        * @return void
         */
        public function init() {
                $this->editorNo = \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('editorNo');
@@ -124,7 +124,7 @@ class UserElementsController {
        /**
         * Main function
         *
-        * @return      [type]          ...
+        * @return void
         */
        public function main() {
                $this->content = '';
@@ -134,7 +134,7 @@ class UserElementsController {
        /**
         * Print content
         *
-        * @return      [type]          ...
+        * @return void
         */
        public function printContent() {
                echo $this->content;
@@ -146,10 +146,10 @@ class UserElementsController {
         *
         *********************************/
        /**
-        * @param       [type]          $imgInfo: ...
-        * @param       [type]          $maxW: ...
-        * @param       [type]          $maxH: ...
-        * @return      [type]          ...
+        * @param array $imgInfo
+        * @param int $maxW
+        * @param int $maxH
+        * @return array
         */
        public function calcWH($imgInfo, $maxW = 380, $maxH = 500) {
                $IW = $imgInfo[0];
@@ -169,8 +169,8 @@ class UserElementsController {
        /**
         * Rich Text Editor (RTE) user element selector
         *
-        * @param       [type]          $openKeys: ...
-        * @return      [type]          ...
+        * @param array $openKeys
+        * @return string
         */
        public function main_user($openKeys) {
                // Starting content:
index 90680e9..3d38b41 100644 (file)
@@ -1511,8 +1511,7 @@ class RteHtmlAreaBase extends \TYPO3\CMS\Backend\Rte\AbstractRte {
         *
         ***************************/
        /**
-        * @return      [type]          ...
-        * @desc
+        * @return string
         */
        public function RTEtsConfigParams() {
                if ($this->is_FE()) {
@@ -1523,6 +1522,12 @@ class RteHtmlAreaBase extends \TYPO3\CMS\Backend\Rte\AbstractRte {
                }
        }
 
+       /**
+        * Clean list
+        *
+        * @param string $str
+        * @return string
+        */
        public function cleanList($str) {
                if (strstr($str, '*')) {
                        $str = '*';