Commit a7169235 authored by Benni Mack's avatar Benni Mack Committed by Frank Nägler
Browse files

[TASK] Add proper comments to PHP code

There are some places where PHP comments have been done wrong (using doccomments)
or where there is no comment at all.

Resolves: #80503
Releases: master
Change-Id: Ib12d3b82755d801abcbefe7127f1189239f766af
Reviewed-on: https://review.typo3.org/52200


Reviewed-by: Wouter Wolters's avatarWouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters's avatarWouter Wolters <typo3@wouterwolters.nl>
Tested-by: default avatarTYPO3com <no-reply@typo3.com>
Reviewed-by: Frank Nägler's avatarFrank Naegler <frank.naegler@typo3.org>
Tested-by: Frank Nägler's avatarFrank Naegler <frank.naegler@typo3.org>
parent 30dfc48c
......@@ -20,6 +20,10 @@ namespace TYPO3\TestingFramework\Core\Functional\Framework\Frontend;
class RequestBootstrap
{
/**
* This method is necessary to set any superglobals like $_SERVER, $_POST, $_COOKIE, $_GET
* to start clean for a functional test.
*
* @param array $requestArguments usually JSON encoded arguments, should include "documentRoot" and "requestUrl"
* @return void
*/
public static function setGlobalVariables(array $requestArguments = null)
......@@ -84,7 +88,7 @@ class RequestBootstrap
}
/**
* @return void
* Calls the set SCRIPT_FILENAME and outputs the contents as JSON
*/
public static function executeAndOutput()
{
......
......@@ -74,6 +74,7 @@ abstract class ViewHelperBaseTestcase extends \TYPO3\TestingFramework\Core\Unit\
protected $mvcPropertyMapperConfigurationService;
/**
* Sets up all properties of a viewhelper needed to test a viewhelper
* @return void
*/
protected function setUp()
......
......@@ -200,7 +200,8 @@ class ElementInformationController
}
/**
* @return void
* Compiles the whole content to be outputted, which is then set as content to the moduleTemplate
* There is a hook to do a custom rendering of a record.
*/
public function main()
{
......
......@@ -102,7 +102,7 @@ class FormInlineAjaxController extends AbstractFormEngineAjaxController
// @todo: of children are only created with the "synchronize" button that will trigger a different ajax action.
// @todo: The edge case of new page overlay together with localized media field, this code won't kick in either.
// @deprecated: IRRE 'localizationMode' is deprecated and will be removed in TYPO3 CMS 9
/**
/*
if ($parent['localizationMode'] === 'select' && MathUtility::canBeInterpretedAsInteger($parent['uid'])) {
$parentRecord = $inlineRelatedRecordResolver->getRecord($parent['table'], $parent['uid']);
$parentLanguageField = $GLOBALS['TCA'][$parent['table']]['ctrl']['languageField'];
......
......@@ -45,7 +45,7 @@ class PaletteAndSingleContainer extends AbstractContainer
{
$languageService = $this->getLanguageService();
/**
/*
* The first code block creates a target structure array to later create the final
* HTML string. The single fields and sub containers are rendered here already and
* other parts of the return array from children except html are accumulated in
......
......@@ -705,7 +705,7 @@ class DataHandler
protected $cachePrefixNestedElementCalls = 'core-datahandler-nestedElementCalls-';
/**
*
* Sets up the data handler cache and some additional options, the main logic is done in the start() method.
*/
public function __construct()
{
......
......@@ -79,6 +79,7 @@ class FlashMessageQueue extends \SplQueue
}
/**
* This method is empty, as it will not move any flash message (e.g. from the session)
* @return void
*/
public function dequeue()
......
......@@ -30,7 +30,7 @@ class DriverRegistry implements \TYPO3\CMS\Core\SingletonInterface
protected $driverConfigurations = [];
/**
* Creates this object.
* Creates this object by detecting all available drivers registered in $TYPO3_CONF_VARS.
*/
public function __construct()
{
......@@ -83,6 +83,9 @@ class DriverRegistry implements \TYPO3\CMS\Core\SingletonInterface
}
/**
* Adds the TCA information so the registered drivers can be selected when creating a sys_file_storage
* in the TYPO3 Backend.
*
* @return void
*/
public function addDriversToTCA()
......
......@@ -388,6 +388,8 @@ class ProcessedFile extends AbstractFile
}
/**
* Defines that the original file should be used.
*
* @return void
*/
public function setUsesOriginalFile()
......
......@@ -179,7 +179,7 @@ class ElementsBasicInputDateCest extends AbstractElementsBasicCest
/**
* @param Admin $I
*/
/**
/*
public function checkThatValidationWorks_EvalDateTime_DbTypeDateTime(Admin $I)
{
// @todo fix these unstable test
......
......@@ -82,6 +82,8 @@ class HelpCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandCon
}
/**
* Builds an index of all commands that are available
*
* @return void
*/
protected function displayHelpIndex()
......
......@@ -254,6 +254,8 @@ class QueryResult implements QueryResultInterface
}
/**
* Ensures that the objectManager, persistenceManager and dataMapper are back when loading the QueryResult
* from the cache
* @return void
*/
public function __wakeup()
......
......@@ -112,7 +112,7 @@ class DownloadController extends AbstractController
}
/**
*
* Defines which view object should be used for the installFromTer action
*/
protected function initializeInstallFromTerAction()
{
......
......@@ -25,6 +25,7 @@ class ClickMenuOnIconViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\Abstrac
protected $tagName = 'a';
/**
* Defines additional arguments that are allowed for this view helper.
* @return void
*/
public function initializeArguments()
......
......@@ -55,6 +55,8 @@ class PaginateController extends \TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetCont
protected $numberOfObjects = 0;
/**
* Initializes necessary variables for all actions.
*
* @return void
*/
public function initializeAction()
......
......@@ -38,6 +38,7 @@ class RenderViewHelper extends AbstractViewHelper
protected $escapeOutput = false;
/**
* Initializes additional arguments available for this view helper.
* @return void
*/
public function initializeArguments()
......
......@@ -28,6 +28,7 @@ class OptgroupViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormF
protected $tagName = 'optgroup';
/**
* Initialize additional arguments available for this tag view helper.
* @return void
*/
public function initializeArguments()
......
......@@ -28,6 +28,7 @@ class OptionViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFie
protected $tagName = 'option';
/**
* Initialize additional arguments available for this tag view helper.
* @return void
*/
public function initializeArguments()
......
......@@ -20,6 +20,8 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller;
class AutocompleteController extends \TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController
{
/**
* Simply assigns the ID of the widget.
*
* @return void
*/
public function indexAction()
......
......@@ -66,6 +66,7 @@ class PaginateController extends AbstractWidgetController
protected $displayRangeEnd = null;
/**
* Initializes the current information on which page the visitor is.
* @return void
*/
public function initializeAction()
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment