merged branch odolbeau/cs (PR #4278)

Commits
-------

3623580 Add missing PHPDoc

Discussion
----------

Add missing PHPDoc + correct PHPDoc alignment

---------------------------------------------------------------------------

by travisbot at 2012-05-14T15:19:29Z

This pull request [passes](http://travis-ci.org/symfony/symfony/builds/1327970) (merged 36235807 into 72b2f698).
This commit is contained in:
Fabien Potencier 2012-05-15 07:10:41 +02:00
commit 07fbd3ef15

View File

@ -47,9 +47,9 @@ class Controller extends ContainerAware
/** /**
* Forwards the request to another controller. * Forwards the request to another controller.
* *
* @param string $controller The controller name (a string like BlogBundle:Post:index) * @param string $controller The controller name (a string like BlogBundle:Post:index)
* @param array $path An array of path parameters * @param array $path An array of path parameters
* @param array $query An array of query parameters * @param array $query An array of query parameters
* *
* @return Response A Response instance * @return Response A Response instance
*/ */
@ -61,7 +61,7 @@ class Controller extends ContainerAware
/** /**
* Returns a RedirectResponse to the given URL. * Returns a RedirectResponse to the given URL.
* *
* @param string $url The URL to redirect to * @param string $url The URL to redirect to
* @param integer $status The status code to use for the Response * @param integer $status The status code to use for the Response
* *
* @return RedirectResponse * @return RedirectResponse
@ -87,9 +87,9 @@ class Controller extends ContainerAware
/** /**
* Renders a view. * Renders a view.
* *
* @param string $view The view name * @param string $view The view name
* @param array $parameters An array of parameters to pass to the view * @param array $parameters An array of parameters to pass to the view
* @param Response $response A response instance * @param Response $response A response instance
* *
* @return Response A Response instance * @return Response A Response instance
*/ */
@ -105,6 +105,9 @@ class Controller extends ContainerAware
* *
* throw $this->createNotFoundException('Page not found!'); * throw $this->createNotFoundException('Page not found!');
* *
* @param string $message A message
* @param Exception $previous The previous exception
*
* @return NotFoundHttpException * @return NotFoundHttpException
*/ */
public function createNotFoundException($message = 'Not Found', \Exception $previous = null) public function createNotFoundException($message = 'Not Found', \Exception $previous = null)
@ -116,8 +119,8 @@ class Controller extends ContainerAware
* Creates and returns a Form instance from the type of the form. * Creates and returns a Form instance from the type of the form.
* *
* @param string|FormTypeInterface $type The built type of the form * @param string|FormTypeInterface $type The built type of the form
* @param mixed $data The initial data for the form * @param mixed $data The initial data for the form
* @param array $options Options for the form * @param array $options Options for the form
* *
* @return Form * @return Form
*/ */
@ -129,8 +132,8 @@ class Controller extends ContainerAware
/** /**
* Creates and returns a form builder instance * Creates and returns a form builder instance
* *
* @param mixed $data The initial data for the form * @param mixed $data The initial data for the form
* @param array $options Options for the form * @param array $options Options for the form
* *
* @return FormBuilder * @return FormBuilder
*/ */
@ -168,7 +171,7 @@ class Controller extends ContainerAware
/** /**
* Returns true if the service id is defined. * Returns true if the service id is defined.
* *
* @param string $id The service id * @param string $id The service id
* *
* @return Boolean true if the service id is defined, false otherwise * @return Boolean true if the service id is defined, false otherwise
*/ */
@ -180,7 +183,7 @@ class Controller extends ContainerAware
/** /**
* Gets a service by id. * Gets a service by id.
* *
* @param string $id The service id * @param string $id The service id
* *
* @return object The service * @return object The service
*/ */