[BUGFIX] Fix @param in phpdoc
authorStefan Neufeind <typo3.neufeind@speedpartner.de>
Tue, 23 Oct 2012 14:57:25 +0000 (16:57 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Sun, 28 Oct 2012 18:12:17 +0000 (19:12 +0100)
Some @param-tags are wrong or don't match
the number of params for the function they
refer to.

Change-Id: I80641f7ef714e9416243336c5a0723b6ca66f80d
Fixes: #42233
Releases: 6.0
Reviewed-on: http://review.typo3.org/15842
Reviewed-by: Wouter Wolters
Tested-by: Wouter Wolters
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
13 files changed:
typo3/sysext/frontend/Classes/ContentObject/ContentObjectRenderer.php
typo3/sysext/frontend/Classes/ContentObject/Menu/AbstractMenuContentObject.php
typo3/sysext/frontend/Classes/Page/PageRepository.php
typo3/sysext/frontend/Classes/View/AdminPanelView.php
typo3/sysext/install/Classes/Installer.php
typo3/sysext/recycler/Classes/Domain/Model/DeletedRecords.php
typo3/sysext/recycler/Classes/Utility/RecyclerUtility.php
typo3/sysext/rtehtmlarea/Classes/BrowseLinks.php
typo3/sysext/rtehtmlarea/Classes/Controller/FrontendRteController.php
typo3/sysext/rtehtmlarea/Classes/FolderTree.php
typo3/sysext/rtehtmlarea/Classes/ImageFolderTree.php
typo3/sysext/rtehtmlarea/Classes/RteHtmlAreaBase.php
typo3/sysext/sys_action/Classes/ActionTask.php

index 8c3669f..343dc27 100644 (file)
@@ -5125,7 +5125,7 @@ class ContentObjectRenderer {
         *
         * @param string $parameters The parameters to be modified (if required)
         * @param array $configuration The TypoScript configuration of [IMAGE].file
-        * @param string The modified parameters
+        * @return string The modified parameters
         */
        protected function modifyImageMagickStripProfileParameters($parameters, array $configuration) {
                // Strips profile information of image to save some space:
index a9d94c4..4d374a3 100644 (file)
@@ -1649,7 +1649,6 @@ class AbstractMenuContentObject {
         * Return MPvar string for entry $key in ->menuArr
         *
         * @param integer $key Pointer to element in ->menuArr
-        * @param string Implode token.
         * @return string MP vars for element.
         * @see link()
         * @todo Define visibility
index 6466d68..9c2f4f3 100644 (file)
@@ -788,6 +788,7 @@ class PageRepository {
         * like t3lib_pageSelect::getHash()
         *
         * @param string $hash The hash-string which was used to store the data value
+        * @param integer The expiration time (not used anymore)
         * @return string The "content" field of the "cache_hash" cache entry.
         * @see tslib_TStemplate::start(), storeHash()
         */
index 338da0d..bac7620 100644 (file)
@@ -560,6 +560,7 @@ class AdminPanelView {
         *
         * @param string $sectionSuffix The code for the display_ label/key
         * @param string $sectionTitle Input string
+        * @param string $className The classname for the <a> tag
         * @return string $className Linked input string
         * @see extGetHead()
         */
@@ -573,7 +574,8 @@ class AdminPanelView {
         *
         * @param string $title Key to label
         * @param string $content The HTML content for the forth table cell.
-        * @return string $checkboxContent HTML table row.
+        * @param string $checkboxContent The HTML for a checkbox or hidden fields
+        * @return string HTML table row.
         * @see extGetHead()
         */
        public function extGetItem($title, $content = '', $checkboxContent = '') {
index cc8def7..4348f25 100644 (file)
@@ -6681,7 +6681,8 @@ REMOTE_ADDR was \'' . \TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('REMOTE
         * Outputs an error and dies.
         * Should be used by all errors that occur before even starting the install tool process.
         *
-        * @param string The content of the error
+        * @param string $content The content of the error
+        * @param string $title The title of the page
         * @return void
         */
        protected function outputErrorAndExit($content, $title = 'Install Tool error') {
index fc60b03..9ab6d42 100644 (file)
@@ -269,7 +269,7 @@ class DeletedRecords {
         * There is a special handling for the characters '%' and '_'.
         *
         * @param       string          $value: The value to be escaped for like conditions
-        * @paran       string          $tableName: The name of the table the query should be used for
+        * @param       string          $tableName: The name of the table the query should be used for
         * @return      string          The escaped value to be used for like conditions
         */
        protected function escapeValueForLike($value, $tableName) {
index 8472c56..1a427d6 100644 (file)
@@ -41,10 +41,9 @@ class RecyclerUtility {
         * Checks the page access rights (Code for access check mostly taken from alt_doc.php)
         * as well as the table access rights of the user.
         *
-        * @param       string          $cmd: The command that sould be performed ('new' or 'edit')
-        * @param       string          $table: The table to check access for
-        * @param       string          $theUid: The record uid of the table
-        * @return      boolean         Returns TRUE is the user has access, or FALSE if not
+        * @param string $table The table to check access for
+        * @param string $row Record array
+        * @return boolean Returns TRUE is the user has access, or FALSE if not
         */
        static public function checkAccess($table, $row) {
                // Checking if the user has permissions? (Only working as a precaution, because the final permission check is always down in TCE. But it's good to notify the user on beforehand...)
index ce82c99..94b34d4 100644 (file)
@@ -957,8 +957,9 @@ class BrowseLinks extends \TYPO3\CMS\Recordlist\Browser\ElementBrowser {
        /**
         * Localize a label obtained from Page TSConfig
         *
-        * @param       string          string: the label to be localized
-        * @return      string          Localized string.
+        * @param string $string The label to be localized
+        * @param boolean $JScharCode If needs to be converted to a array of char numbers
+        * @return string Localized string.
         */
        public function getPageConfigLabel($string, $JScharCode = 1) {
                if (strcmp(substr($string, 0, 4), 'LLL:')) {
index 06c6bab..122ec25 100644 (file)
@@ -290,7 +290,7 @@ class FrontendRteController extends \TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase {
         * @param       string          $key: some key identifying the style sheet
         * @param       string          $href: uri to the style sheet file
         * @param       string          $title: value for the title attribute of the link element
-        * @return      string          $relation: value for the rel attribute of the link element
+        * @param       string          $relation: value for the rel attribute of the link element
         * @return      void
         */
        protected function addStyleSheet($key, $href, $title = '', $relation = 'stylesheet') {
index 6dd2f2c..eba7020 100644 (file)
@@ -31,9 +31,10 @@ class FolderTree extends \rteFolderTree {
        /**
         * Wrap the plus/minus icon in a link
         *
-        * @param       string          HTML string to wrap, probably an image tag.
-        * @param       string          Command for 'PM' get var
-        * @return      string          Link-wrapped input string
+        * @param string $icon HTML string to wrap, probably an image tag.
+        * @param string $cmd Command for 'PM' get var
+        * @param boolean $isExpand If expanded
+        * @return string Link-wrapped input string
         * @access private
         */
        public function PMiconATagWrap($icon, $cmd, $isExpand = TRUE) {
index f181d12..7706895 100644 (file)
@@ -79,9 +79,10 @@ class ImageFolderTree extends TBE_FolderTree {
        /**
         * Wrap the plus/minus icon in a link
         *
-        * @param       string          HTML string to wrap, probably an image tag.
-        * @param       string          Command for 'PM' get var
-        * @return      string          Link-wrapped input string
+        * @param string $icon HTML string to wrap, probably an image tag.
+        * @param string $cmd Command for 'PM' get var
+        * @param boolean $isExpand If expanded
+        * @return string Link-wrapped input string
         * @access private
         */
        public function PMiconATagWrap($icon, $cmd, $isExpand = TRUE) {
index 3e520b4..db2f108 100644 (file)
@@ -578,7 +578,7 @@ class RteHtmlAreaBase extends \TYPO3\CMS\Backend\Rte\AbstractRte {
         * @param       string          $key: some key identifying the style sheet
         * @param       string          $href: uri to the style sheet file
         * @param       string          $title: value for the title attribute of the link element
-        * @return      string          $relation: value for the rel attribute of the link element
+        * @param       string          $relation: value for the rel attribute of the link element
         * @return      void
         */
        protected function addStyleSheet($key, $href, $title = '', $relation = 'stylesheet') {
@@ -862,6 +862,7 @@ class RteHtmlAreaBase extends \TYPO3\CMS\Backend\Rte\AbstractRte {
         * @param       string          $table: The table that includes this RTE (optional, necessary for IRRE).
         * @param       string          $uid: The uid of that table that includes this RTE (optional, necessary for IRRE).
         * @param       string          $field: The field of that record that includes this RTE (optional).
+        * @param       string          $textAreaId ID of the textarea, to have a unigue number for the editor
         * @return      string          the Javascript code for configuring the RTE
         * @todo Define visibility
         */
@@ -1118,6 +1119,7 @@ class RteHtmlAreaBase extends \TYPO3\CMS\Backend\Rte\AbstractRte {
         * @param       string          $label: A label to insert at the beginning of the name of the file
         * @param       string          $fileExtension: The file extension of the file, defaulting to 'js'
         * @param       string          $contents: The contents to write into the file if no $sourceFileName is provided
+        * @param       boolean         $concatenate Not used anymore
         * @return      string          The name of the file writtten to typo3temp/rtehtmlarea
         */
        public function writeTemporaryFile($sourceFileName = '', $label, $fileExtension = 'js', $contents = '', $concatenate = FALSE) {
index e196e2a..0a7f0fd 100644 (file)
@@ -488,6 +488,7 @@ class ActionTask implements \TYPO3\CMS\Taskcenter\TaskInterface {
         * Clean the to be applied usergroups from not allowed ones
         *
         * @param array $appliedUsergroups Array of to be applied user groups
+        * @param array $actionRecord The action record
         * @return array Cleaned array
         */
        protected function fixUserGroup($appliedUsergroups, $actionRecord) {