[CLEANUP] Cleanup wrong doc comments
authorTolleiv Nietsch <info@tolleiv.de>
Sun, 22 Jan 2012 18:31:27 +0000 (19:31 +0100)
committerTolleiv Nietsch <info@tolleiv.de>
Sun, 22 Jan 2012 20:19:47 +0000 (21:19 +0100)
Some of the doc cumments don't reflect the actual method
signature anymore. Better fix it ;)

Change-Id: Ic7ce992a39c307eaea7710a2e02038357a6356b2
Releases: 4.7
Reviewed-on: http://review.typo3.org/8642
Reviewed-by: Tolleiv Nietsch
Tested-by: Tolleiv Nietsch
typo3/sysext/workspaces/Classes/Controller/PreviewController.php
typo3/sysext/workspaces/Classes/ExtDirect/ActionHandler.php
typo3/sysext/workspaces/Classes/ExtDirect/Server.php
typo3/sysext/workspaces/Classes/ExtDirect/ToolbarMenu.php
typo3/sysext/workspaces/Classes/Service/AutoPublishTask.php
typo3/sysext/workspaces/Classes/Service/Fehooks.php
typo3/sysext/workspaces/Classes/Service/GridData.php
typo3/sysext/workspaces/Classes/Service/Workspaces.php

index 0dcf64c..18ee6c6 100644 (file)
@@ -215,7 +215,7 @@ class Tx_Workspaces_Controller_PreviewController extends Tx_Workspaces_Controlle
         * and since we're loading a backend module outside of the actual backend
         * this copies parts of the backend.php
         *
-        * @return      void
+        * @return      string
         */
        protected function generateJavascript() {
                $pathTYPO3 = t3lib_div::dirname(t3lib_div::getIndpEnv('SCRIPT_NAME')) . '/';
index 8a55e96..8e21bf8 100644 (file)
@@ -96,7 +96,7 @@ class Tx_Workspaces_ExtDirect_ActionHandler extends Tx_Workspaces_ExtDirect_Abst
         *
         * @param string $table
         * @param string $uid
-        * @return void
+        * @return string
         */
        public function viewSingleRecord($table, $uid) {
                return Tx_Workspaces_Service_Workspaces::viewSingleRecord($table, $uid);
@@ -378,7 +378,7 @@ class Tx_Workspaces_ExtDirect_ActionHandler extends Tx_Workspaces_ExtDirect_Abst
         *      additional: string
         *      comments: string
         *
-        * @param stdObject $parameters
+        * @param stdClass $parameters
         * @return array
         */
        public function sendToNextStageExecute(stdClass $parameters) {
@@ -424,7 +424,7 @@ class Tx_Workspaces_ExtDirect_ActionHandler extends Tx_Workspaces_ExtDirect_Abst
         *      additional: string
         *      comments: string
         *
-        * @param stdObject $parameters
+        * @param stdClass $parameters
         * @return array
         */
        public function sendToPrevStageExecute(stdClass $parameters) {
@@ -469,7 +469,7 @@ class Tx_Workspaces_ExtDirect_ActionHandler extends Tx_Workspaces_ExtDirect_Abst
         *      additional: string
         *      comments: string
         *
-        * @param stdObject $parameters
+        * @param stdClass $parameters
         * @return array
         */
        public function sendToSpecificStageExecute(stdClass $parameters) {
index fc17a51..5919b5f 100644 (file)
@@ -180,7 +180,8 @@ class Tx_Workspaces_ExtDirect_Server extends Tx_Workspaces_ExtDirect_AbstractHan
         * Gets an array with all sys_log entries and their comments for the given record uid and table
         *
         * @param integer $uid uid of changed element to search for in log
-        * @return string $table table name
+        * @param string $table table name
+        * @return array
         */
        public function getCommentsForRecord($uid, $table) {
                $stagesService = t3lib_div::makeInstance('Tx_Workspaces_Service_Stages');
index 54ab4b2..abc60a0 100644 (file)
@@ -45,7 +45,7 @@ class Tx_Workspaces_ExtDirect_ToolbarMenu {
 
        /**
         * @param $parameter
-        * @return
+        * @return array
         */
        public function setWorkspace($parameter) {
                $workspaceId = intval($parameter->workSpaceId);
index afa15fe..f9cdf67 100644 (file)
@@ -37,7 +37,7 @@ class Tx_Workspaces_Service_AutoPublishTask extends tx_scheduler_Task {
         * Call on the workspace logic to publish workspaces whose publication date
         * is in the past
         *
-        * @return      void
+        * @return      boolean
         */
        public function execute() {
                $autopubObj = t3lib_div::makeInstance('Tx_Workspaces_Service_AutoPublish');
index addb852..7e0834a 100644 (file)
@@ -33,8 +33,9 @@
 class Tx_Workspaces_Service_Fehooks {
 
        /**
+        * @param array $params
         * @param tslib_fe $pObj
-        * @return void
+        * @return mixed
         */
        public function hook_eofe($params, $pObj) {
                if ($pObj->fePreview != 2) {
index 3ba030c..8e8e16f 100644 (file)
@@ -42,6 +42,7 @@ class Tx_Workspaces_Service_GridData {
         *
         * @param array $versions All records uids etc. First key is table name, second key incremental integer. Records are associative arrays with uid, t3ver_oid and t3ver_swapmode fields. The pid of the online record is found as "livepid" the pid of the offline record is found in "wspid"
         * @param object $parameter
+        * @param integer $currentWorkspace
         * @return array
         * @throws InvalidArgumentException
         */
@@ -235,6 +236,7 @@ class Tx_Workspaces_Service_GridData {
         *
         * @param array $versions All records uids etc. First key is table name, second key incremental integer. Records are associative arrays with uid, t3ver_oid and t3ver_swapmode fields. The pid of the online record is found as "livepid" the pid of the offline record is found in "wspid"
         * @param string $filterTxt The given filter text from the grid.
+        * @return string
         */
        protected function calculateHash (array $versions, $filterTxt) {
                $hashArray = array(
index 4a59143..95c7ad0 100644 (file)
@@ -304,6 +304,8 @@ class Tx_Workspaces_Service_Workspaces implements t3lib_Singleton {
         * @param string $table
         * @param string $pageList
         * @param integer $wsid
+        * @param integer $filter
+        * @param integer $stage
         * @return array
         */
        protected function getMoveToPlaceHolderFromPages($table, $pageList, $wsid, $filter, $stage) {
@@ -567,7 +569,7 @@ class Tx_Workspaces_Service_Workspaces implements t3lib_Singleton {
         *
         * @param  $pageUid
         * @param  $workspaceUid
-        * @return void
+        * @return boolean
         */
        public function canCreatePreviewLink($pageUid, $workspaceUid) {
                $result = TRUE;