Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Cleanup @return annotations #42495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Console/Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public function __construct(KernelInterface $kernel)
/**
* Gets the Kernel associated with this Console.
*
* @return KernelInterface A KernelInterface instance
* @return KernelInterface
*/
public function getKernel()
{
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/KernelBrowser.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public function getKernel()
/**
* Gets the profile associated with the current Response.
*
* @return HttpProfile|false|null A Profile instance
* @return HttpProfile|false|null
*/
public function getProfile()
{
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ protected static function getKernelClass()
/**
* Boots the Kernel for this test.
*
* @return KernelInterface A KernelInterface instance
* @return KernelInterface
*/
protected static function bootKernel(array $options = [])
{
Expand Down Expand Up @@ -118,7 +118,7 @@ protected static function getContainer(): ContainerInterface
* * environment
* * debug
*
* @return KernelInterface A KernelInterface instance
* @return KernelInterface
*/
protected static function createKernel(array $options = [])
{
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Test/WebTestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ protected function tearDown(): void
* @param array $options An array of options to pass to the createKernel method
* @param array $server An array of server parameters
*
* @return KernelBrowser A KernelBrowser instance
* @return KernelBrowser
*/
protected static function createClient(array $options = [], array $server = [])
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public function __construct(UrlGeneratorInterface $generator, Profiler $profiler
/**
* Redirects to the last profiles.
*
* @return RedirectResponse A RedirectResponse instance
* @return RedirectResponse
*
* @throws NotFoundHttpException
*/
Expand All @@ -66,7 +66,7 @@ public function homeAction()
/**
* Renders a profiler panel for the given token.
*
* @return Response A Response instance
* @return Response
*
* @throws NotFoundHttpException
*/
Expand Down Expand Up @@ -125,7 +125,7 @@ public function panelAction(Request $request, string $token)
/**
* Renders the Web Debug Toolbar.
*
* @return Response A Response instance
* @return Response
*
* @throws NotFoundHttpException
*/
Expand Down Expand Up @@ -170,7 +170,7 @@ public function toolbarAction(Request $request, string $token = null)
/**
* Renders the profiler search bar.
*
* @return Response A Response instance
* @return Response
*
* @throws NotFoundHttpException
*/
Expand Down Expand Up @@ -224,7 +224,7 @@ public function searchBarAction(Request $request)
/**
* Renders the search results.
*
* @return Response A Response instance
* @return Response
*
* @throws NotFoundHttpException
*/
Expand Down Expand Up @@ -265,7 +265,7 @@ public function searchResultsAction(Request $request, string $token)
/**
* Narrows the search bar.
*
* @return Response A Response instance
* @return Response
*
* @throws NotFoundHttpException
*/
Expand Down Expand Up @@ -316,7 +316,7 @@ public function searchAction(Request $request)
/**
* Displays the PHP info.
*
* @return Response A Response instance
* @return Response
*
* @throws NotFoundHttpException
*/
Expand All @@ -338,7 +338,7 @@ public function phpinfoAction()
/**
* Displays the source of a file.
*
* @return Response A Response instance
* @return Response
*
* @throws NotFoundHttpException
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public function __construct(Profiler $profiler = null, Environment $twig, UrlMat
/**
* Renders the profiler panel for the given token.
*
* @return Response A Response instance
* @return Response
*
* @throws NotFoundHttpException
*/
Expand Down
36 changes: 12 additions & 24 deletions src/Symfony/Component/BrowserKit/AbstractBrowser.php
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,6 @@ public function getMaxRedirects()
/**
* Sets the insulated flag.
*
* @param bool $insulated Whether to insulate the requests or not
*
* @throws \RuntimeException When Symfony Process Component is not installed
*/
public function insulate(bool $insulated = true)
Expand All @@ -120,8 +118,6 @@ public function insulate(bool $insulated = true)

/**
* Sets server parameters.
*
* @param array $server An array of server parameters
*/
public function setServerParameters(array $server)
{
Expand All @@ -143,7 +139,7 @@ public function setServerParameter(string $key, string $value)
*
* @param mixed $default A default value when key is undefined
*
* @return mixed A value of the parameter
* @return mixed
*/
public function getServerParameter(string $key, $default = '')
{
Expand Down Expand Up @@ -182,7 +178,7 @@ public function jsonRequest(string $method, string $uri, array $parameters = [],
/**
* Returns the History instance.
*
* @return History A History instance
* @return History
*/
public function getHistory()
{
Expand All @@ -192,7 +188,7 @@ public function getHistory()
/**
* Returns the CookieJar instance.
*
* @return CookieJar A CookieJar instance
* @return CookieJar
*/
public function getCookieJar()
{
Expand All @@ -202,7 +198,7 @@ public function getCookieJar()
/**
* Returns the current Crawler instance.
*
* @return Crawler A Crawler instance
* @return Crawler
*/
public function getCrawler()
{
Expand All @@ -216,7 +212,7 @@ public function getCrawler()
/**
* Returns the current BrowserKit Response instance.
*
* @return Response A BrowserKit Response instance
* @return Response
*/
public function getInternalResponse()
{
Expand All @@ -233,7 +229,7 @@ public function getInternalResponse()
* The origin response is the response instance that is returned
* by the code that handles requests.
*
* @return object A response instance
* @return object
*
* @see doRequest()
*/
Expand All @@ -249,7 +245,7 @@ public function getResponse()
/**
* Returns the current BrowserKit Request instance.
*
* @return Request A BrowserKit Request instance
* @return Request
*/
public function getInternalRequest()
{
Expand All @@ -266,7 +262,7 @@ public function getInternalRequest()
* The origin request is the request instance that is sent
* to the code that handles requests.
*
* @return object A Request instance
* @return object
*
* @see doRequest()
*/
Expand Down Expand Up @@ -435,9 +431,7 @@ public function request(string $method, string $uri, array $parameters = [], arr
/**
* Makes a request in another process.
*
* @param object $request An origin request instance
*
* @return object An origin response instance
* @return object
*
* @throws \RuntimeException When processing returns exit code
*/
Expand Down Expand Up @@ -472,9 +466,7 @@ protected function doRequestInProcess(object $request)
/**
* Makes a request.
*
* @param object $request An origin request instance
*
* @return object An origin response instance
* @return object
*/
abstract protected function doRequest(object $request);

Expand All @@ -493,7 +485,7 @@ protected function getScript(object $request)
/**
* Filters the BrowserKit request to the origin one.
*
* @return object An origin request instance
* @return object
*/
protected function filterRequest(Request $request)
{
Expand All @@ -503,9 +495,7 @@ protected function filterRequest(Request $request)
/**
* Filters the origin response to the BrowserKit one.
*
* @param object $response The origin response to filter
*
* @return Response An BrowserKit Response instance
* @return Response
*/
protected function filterResponse(object $response)
{
Expand Down Expand Up @@ -649,8 +639,6 @@ public function restart()
/**
* Takes a URI and converts it to absolute if it is not already absolute.
*
* @param string $uri A URI
*
* @return string An absolute URI
*/
protected function getAbsoluteUri(string $uri)
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/BrowserKit/CookieJar.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public function set(Cookie $cookie)
* (this behavior ensures a BC behavior with previous versions of
* Symfony).
*
* @return Cookie|null A Cookie instance or null if the cookie does not exist
* @return Cookie|null
*/
public function get(string $name, string $path = '/', string $domain = null)
{
Expand Down
6 changes: 3 additions & 3 deletions src/Symfony/Component/BrowserKit/History.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public function isEmpty()
/**
* Goes back in the history.
*
* @return Request A Request instance
* @return Request
*
* @throws \LogicException if the stack is already on the first page
*/
Expand All @@ -69,7 +69,7 @@ public function back()
/**
* Goes forward in the history.
*
* @return Request A Request instance
* @return Request
*
* @throws \LogicException if the stack is already on the last page
*/
Expand All @@ -85,7 +85,7 @@ public function forward()
/**
* Returns the current element in the history.
*
* @return Request A Request instance
* @return Request
*
* @throws \LogicException if the stack is empty
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Cache/Adapter/PdoAdapter.php
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class PdoAdapter extends AbstractAdapter implements PruneableInterface
* * db_password: The password when lazy-connect [default: '']
* * db_connection_options: An array of driver-specific connection options [default: []]
*
* @param \PDO|Connection|string $connOrDsn a \PDO or Connection instance or DSN string or null
* @param \PDO|Connection|string $connOrDsn
*
* @throws InvalidArgumentException When first argument is not PDO nor Connection nor string
* @throws InvalidArgumentException When PDO error mode is not PDO::ERRMODE_EXCEPTION
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ interface ConfigCacheFactoryInterface
* @param string $file The absolute cache file path
* @param callable $callable The callable to be executed when the cache needs to be filled (i. e. is not fresh). The cache will be passed as the only parameter to this callback
*
* @return ConfigCacheInterface The cache instance
* @return ConfigCacheInterface
*/
public function cache(string $file, callable $callable);
}
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ protected function normalization()
/**
* Instantiate and configure the node according to this definition.
*
* @return NodeInterface The node instance
* @return NodeInterface
*
* @throws InvalidDefinitionException When the definition is invalid
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ protected function mergeValues($leftSide, $rightSide)
* Now, the key becomes 'name001' and the child node becomes 'value001' and
* the prototype of child node 'name001' should be a ScalarNode instead of an ArrayNode instance.
*
* @return mixed The prototype instance
* @return mixed
*/
private function getPrototypeForChild(string $key)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Config/Loader/LoaderInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public function supports($resource, string $type = null);
/**
* Gets the loader resolver.
*
* @return LoaderResolverInterface A LoaderResolverInterface instance
* @return LoaderResolverInterface
*/
public function getResolver();

Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Config/Loader/LoaderResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public function addLoader(LoaderInterface $loader)
/**
* Returns the registered loaders.
*
* @return LoaderInterface[] An array of LoaderInterface instances
* @return LoaderInterface[]
*/
public function getLoaders()
{
Expand Down
Loading