fixed phpdoc

pborreli · fabpot · commit cdc9c946285e · 2010-04-26T14:08:30.000+02:00
diff --git a/src/Symfony/Components/BrowserKit/Client.php b/src/Symfony/Components/BrowserKit/Client.php
@@ -70,6 +70,8 @@ public function followRedirects($followRedirect = true)
    * Sets the insulated flag.
    *
    * @param Boolean $insulated Whether to insulate the requests or not
+   *
+   * @throws \RuntimeException When Symfony Process Component is not installed
    */
   public function insulate($insulated = true)
   {
@@ -231,7 +233,9 @@ public function request($method, $uri, $parameters = array(), $headers = array()
    *
    * @param Request $request A Request instance
    *
-   * @param Response $response A Response instance
+   * @return Response A Response instance
+   *
+   * @throws \RuntimeException When processing returns exit code
    */
   protected function doRequestInProcess($request)
   {
@@ -249,16 +253,18 @@ protected function doRequestInProcess($request)
   /**
    * Makes a request.
    *
-   * @param Request  $request A Request instance
+   * @param Request $request A Request instance
    *
-   * @param Response $response A Response instance
+   * @return Response A Response instance
    */
   abstract protected function doRequest($request);
 
   /**
    * Returns the script to execute when the request must be insulated.
    *
    * @param Request $request A Request instance
+   *
+   * @throws \LogicException When this abstract class is not implemented
    */
   protected function getScript($request)
   {
@@ -312,9 +318,9 @@ public function reload()
   /**
    * Follow redirects?
    *
-   * @throws \LogicException If request was not a redirect
-   *
    * @return Symfony\Components\BrowserKit\Client
+   *
+   * @throws \LogicException If request was not a redirect
    */
   public function followRedirect()
   {
diff --git a/src/Symfony/Components/Console/Command/Command.php b/src/Symfony/Components/Console/Command/Command.php
@@ -91,7 +91,7 @@ protected function configure()
    *
    * @return integer 0 if everything went fine, or an error code
    *
-   * @throws \LogicException When this abstrass class is not implemented
+   * @throws \LogicException When this abstract class is not implemented
    */
   protected function execute(InputInterface $input, OutputInterface $output)
   {
diff --git a/src/Symfony/Components/DomCrawler/Form.php b/src/Symfony/Components/DomCrawler/Form.php
@@ -31,7 +31,7 @@ class Form
   /**
    * Constructor.
    *
-   * @param \DOMNode $node A \DOMNode instance
+   * @param \DOMNode $node   A \DOMNode instance
    * @param string   $method The method to use for the link (if null, it defaults to the method defined by the form)
    * @param string   $host   The base URI to use for absolute links (like http://localhost)
    * @param string   $path   The base path for relative links (/ by default)

Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,8 @@ public function followRedirects($followRedirect = true)`
`70`	`70`	`* Sets the insulated flag.`
`71`	`71`	`*`
`72`	`72`	`* @param Boolean $insulated Whether to insulate the requests or not`
	`73`	`+ *`
	`74`	`+ * @throws \RuntimeException When Symfony Process Component is not installed`
`73`	`75`	`*/`
`74`	`76`	`public function insulate($insulated = true)`
`75`	`77`	`{`
`@@ -231,7 +233,9 @@ public function request($method, $uri, $parameters = array(), $headers = array()`
`231`	`233`	`*`
`232`	`234`	`* @param Request $request A Request instance`
`233`	`235`	`*`
`234`		`- * @param Response $response A Response instance`
	`236`	`+ * @return Response A Response instance`
	`237`	`+ *`
	`238`	`+ * @throws \RuntimeException When processing returns exit code`
`235`	`239`	`*/`
`236`	`240`	`protected function doRequestInProcess($request)`
`237`	`241`	`{`
`@@ -249,16 +253,18 @@ protected function doRequestInProcess($request)`
`249`	`253`	`/**`
`250`	`254`	`* Makes a request.`
`251`	`255`	`*`
`252`		`- * @param Request $request A Request instance`
	`256`	`+ * @param Request $request A Request instance`
`253`	`257`	`*`
`254`		`- * @param Response $response A Response instance`
	`258`	`+ * @return Response A Response instance`
`255`	`259`	`*/`
`256`	`260`	`abstract protected function doRequest($request);`
`257`	`261`
`258`	`262`	`/**`
`259`	`263`	`* Returns the script to execute when the request must be insulated.`
`260`	`264`	`*`
`261`	`265`	`* @param Request $request A Request instance`
	`266`	`+ *`
	`267`	`+ * @throws \LogicException When this abstract class is not implemented`
`262`	`268`	`*/`
`263`	`269`	`protected function getScript($request)`
`264`	`270`	`{`
`@@ -312,9 +318,9 @@ public function reload()`
`312`	`318`	`/**`
`313`	`319`	`* Follow redirects?`
`314`	`320`	`*`
`315`		`- * @throws \LogicException If request was not a redirect`
`316`		`- *`
`317`	`321`	`* @return Symfony\Components\BrowserKit\Client`
	`322`	`+ *`
	`323`	`+ * @throws \LogicException If request was not a redirect`
`318`	`324`	`*/`
`319`	`325`	`public function followRedirect()`
`320`	`326`	`{`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ protected function configure()`
`91`	`91`	`*`
`92`	`92`	`* @return integer 0 if everything went fine, or an error code`
`93`	`93`	`*`
`94`		`- * @throws \LogicException When this abstrass class is not implemented`
	`94`	`+ * @throws \LogicException When this abstract class is not implemented`
`95`	`95`	`*/`
`96`	`96`	`protected function execute(InputInterface $input, OutputInterface $output)`
`97`	`97`	`{`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class Form`
`31`	`31`	`/**`
`32`	`32`	`* Constructor.`
`33`	`33`	`*`
`34`		`- * @param \DOMNode $node A \DOMNode instance`
	`34`	`+ * @param \DOMNode $node A \DOMNode instance`
`35`	`35`	`* @param string $method The method to use for the link (if null, it defaults to the method defined by the form)`
`36`	`36`	`* @param string $host The base URI to use for absolute links (like http://localhost)`
`37`	`37`	`* @param string $path The base path for relative links (/ by default)`