merged branch xrstf/2.1 (PR symfony#5687)

fabpot · fabpot · commit f15217089963 · 2012-10-06T21:56:03.000+02:00
This PR was merged into the 2.1 branch. Commits ------- 65cf3a0 added doc comments Discussion ---------- added doc comments --------------------------------------------------------------------------- by stof at 2012-10-06T11:27:23Z closing in favor of symfony#5686 which targets 2.0 --------------------------------------------------------------------------- by fabpot at 2012-10-06T12:38:17Z This one cannot be closed as it contains more phpdocs than in the 2.0 branch.
diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -653,7 +653,7 @@ public function setCommandLine($commandline)
     /**
      * Gets the process timeout.
      *
-     * @return integer The timeout in seconds
+     * @return integer|null The timeout in seconds or null if it's disabled
      */
     public function getTimeout()
     {
@@ -666,6 +666,8 @@ public function getTimeout()
      * To disable the timeout, set this value to null.
      *
      * @param integer|null $timeout The timeout in seconds
+     *
+     * @throws \InvalidArgumentException if the timeout is negative
      */
     public function setTimeout($timeout)
     {
@@ -764,11 +766,23 @@ public function setOptions(array $options)
         $this->options = $options;
     }
 
+    /**
+     * Gets whether or not Windows compatibility is enabled
+     *
+     * This is true by default.
+     *
+     * @return Boolean
+     */
     public function getEnhanceWindowsCompatibility()
     {
         return $this->enhanceWindowsCompatibility;
     }
 
+    /**
+     * Sets whether or not Windows compatibility is enabled
+     *
+     * @param Boolean $enhance
+     */
     public function setEnhanceWindowsCompatibility($enhance)
     {
         $this->enhanceWindowsCompatibility = (Boolean) $enhance;

Original file line number	Diff line number	Diff line change
`@@ -653,7 +653,7 @@ public function setCommandLine($commandline)`
`653`	`653`	`/**`
`654`	`654`	`* Gets the process timeout.`
`655`	`655`	`*`
`656`		`- * @return integer The timeout in seconds`
	`656`	`+ * @return integer\|null The timeout in seconds or null if it's disabled`
`657`	`657`	`*/`
`658`	`658`	`public function getTimeout()`
`659`	`659`	`{`
`@@ -666,6 +666,8 @@ public function getTimeout()`
`666`	`666`	`* To disable the timeout, set this value to null.`
`667`	`667`	`*`
`668`	`668`	`* @param integer\|null $timeout The timeout in seconds`
	`669`	`+ *`
	`670`	`+ * @throws \InvalidArgumentException if the timeout is negative`
`669`	`671`	`*/`
`670`	`672`	`public function setTimeout($timeout)`
`671`	`673`	`{`
`@@ -764,11 +766,23 @@ public function setOptions(array $options)`
`764`	`766`	`$this->options = $options;`
`765`	`767`	`}`
`766`	`768`
	`769`	`+ /**`
	`770`	`+ * Gets whether or not Windows compatibility is enabled`
	`771`	`+ *`
	`772`	`+ * This is true by default.`
	`773`	`+ *`
	`774`	`+ * @return Boolean`
	`775`	`+ */`
`767`	`776`	`public function getEnhanceWindowsCompatibility()`
`768`	`777`	`{`
`769`	`778`	`return $this->enhanceWindowsCompatibility;`
`770`	`779`	`}`
`771`	`780`
	`781`	`+ /**`
	`782`	`+ * Sets whether or not Windows compatibility is enabled`
	`783`	`+ *`
	`784`	`+ * @param Boolean $enhance`
	`785`	`+ */`
`772`	`786`	`public function setEnhanceWindowsCompatibility($enhance)`
`773`	`787`	`{`
`774`	`788`	`$this->enhanceWindowsCompatibility = (Boolean) $enhance;`