silverstripe / silverstripe-behat-extension

src/SilverStripe/BehatExtension/Compiler/MinkExtensionBaseUrlPass.php

Doc Comments +2 added lines, -1 removed lines

@@ -58,7 +58,7 @@ 
      * Copied logic from Core.php, because it needs to be executed prior to {@link SilverStripeAwareInitializer}.
      *
      * @param String Absolute start path to search upwards from
-     * @return Boolean Absolute path to environment file
+     * @return string|null Absolute path to environment file
      */
     protected function findEnvironmentConfigFile($path) {
         $envPath = null;
@@ -85,6 +85,7 @@ 
      *
      * @param String Absolute start path to search upwards from
      * @param Array Map of paths to host names
+     * @param string $path
      * @return String URL
      */
     protected function findBaseUrlFromMapping($path, $mapping) {

src/SilverStripe/BehatExtension/Context/BasicContext.php

Doc Comments +2 added lines, -1 removed lines

@@ -750,7 +750,7 @@ 
      * - fieldset[data-name] table
      * - table caption
      *
-     * @return Behat\Mink\Element\NodeElement
+     * @return \Behat\Mink\Element\NodeElement|null
      */
     protected function getTable($selector) {
         $selector = $this->getSession()->getSelectorsHandler()->xpathLiteral($selector);
@@ -971,6 +971,7 @@ 
 	
 	/**
 	 * We have to catch exceptions and log somehow else otherwise behat falls over
+	 * @param \WebDriver\Exception $e
 	 */
 	protected function logException($e){
 		file_put_contents('php://stderr', 'Exception caught: '.$e);

src/SilverStripe/BehatExtension/Context/ClassGuesser/ModuleContextClassGuesser.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
     /**
      * Sets bundle namespace to use for guessing.
      *
-     * @param string $namespace
+     * @param string $namespaceBase
      */
     public function setNamespaceBase($namespaceBase)
     {

src/SilverStripe/BehatExtension/Context/LoginContext.php

Doc Comments +2 added lines

@@ -121,6 +121,8 @@
 
      /**
      * @When /^I log in with "(?<username>[^"]*)" and "(?<password>[^"]*)"$/
+     * @param string $email
+     * @param string $password
      */
     public function stepILogInWith($email, $password)
     {        

src/SilverStripe/BehatExtension/Context/SilverStripeAwareContextInterface.php

Doc Comments +4 added lines, -2 removed lines

@@ -21,14 +21,16 @@
     /**
      * Sets SilverStripe instance.
      *
-     * @param String $database_name Temp database name
+     * @param String $databaseName Temp database name
+     * @return void
      */
     public function setDatabase($databaseName);
 
     /**
      * Marks steps as AJAX steps for special treatment
      * 
-     * @param array $ajax_steps Array of step name parts to match
+     * @param array $ajaxSteps Array of step name parts to match
+     * @return void
      */
      public function setAjaxSteps($ajaxSteps);
 }

src/SilverStripe/BehatExtension/Context/SilverStripeContext.php

Doc Comments +1 added lines, -1 removed lines

@@ -134,7 +134,7 @@
 	 * When using the "data-title" attribute, ensure not to include double quotes.
 	 *
 	 * @param String $region Region name or CSS selector
-	 * @return MinkElement|null
+	 * @return \Behat\Mink\Element\NodeElement
 	 */
 	public function getRegionObj($region) {
 		// Try to find regions directly by CSS selector.

src/SilverStripe/BehatExtension/Extension.php

Doc Comments +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
     }
 
     /**
-     * @return array
+     * @return Compiler\CoreInitializationPass[]
      */
     public function getCompilerPasses()
     {

src/SilverStripe/BehatExtension/Context/FixtureContext.php

Doc Comments +4 added lines

@@ -555,6 +555,10 @@
 		return $data;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $identifier
+	 */
 	protected function prepareAsset($class, $identifier, $data = null) {
 		if(!$data) $data = array();
 		$relativeTargetPath = (isset($data['Filename'])) ? $data['Filename'] : $identifier;