datasift / storyplayer

src/php/DataSift/Storyplayer/ConfigLib/ActiveConfig.php

Doc Comments +6 added lines

@@ -105,11 +105,17 @@
         $activeConfig->roles = $rolesTable->$testEnvName;
 	}
 
+	/**
+	 * @param Injectables $injectables
+	 */
 	public function mergeStoryplayerConfig($injectables, $spConf)
 	{
 		$this->mergeData('storyplayer', $spConf);
 	}
 
+	/**
+	 * @param Injectables $injectables
+	 */
 	public function mergeSystemUnderTestConfig($injectables, SystemUnderTestConfig $sutConfig = null)
 	{
         // do we have a system under test?

src/php/DataSift/Storyplayer/ConfigLib/ConfigList.php

Doc Comments +5 added lines, -2 removed lines

@@ -83,6 +83,8 @@ 
 
     /**
      * constructor
+     * @param string $configType
+     * @param string[] $searchFolders
      */
     public function __construct($configType, $searchFolders)
     {
@@ -195,6 +197,7 @@ 
     /**
      * build a list of the config files in the $searchFolder
      *
+     * @param string $searchPattern
      * @return array<string>
      */
     protected function findConfigFilenames($searchPattern)
@@ -329,7 +332,7 @@ 
     /**
      * returns our list of all known configs
      *
-     * @return array
+     * @return SystemUnderTestConfig[]
      */
     public function getEntries()
     {
@@ -339,7 +342,7 @@ 
     /**
      * returns the names of all of the entries in our list
      *
-     * @return array<string>
+     * @return integer[]
      */
     public function getEntryNames()
     {

src/php/DataSift/Storyplayer/DefinitionLib/TestEnvironment/GroupDefinition.php

Doc Comments +2 added lines, -2 removed lines

@@ -220,7 +220,7 @@ 
     /**
      * how should we provision this environment?
      *
-     * @return array<ProvisioningAdapters>
+     * @return ProvisioningAdapter[]
      */
     public function getProvisioningAdapters()
     {
@@ -265,7 +265,7 @@ 
     /**
      * what hosts exist in this group?
      *
-     * @return array<TestEnvironment_HostDefinition>
+     * @return TestEnvironmentHost[]
      */
     public function getHosts()
     {

src/php/DataSift/Storyplayer/DefinitionLib/TestEnvironment/HostDefinition.php

Doc Comments +3 added lines

@@ -74,6 +74,9 @@
      */
     protected $storySettings;
 
+    /**
+     * @param string $hostId
+     */
     public function __construct(TestEnvironment_GroupDefinition $parentGroup, $hostId)
     {
         $this->setParentGroup($parentGroup);

src/php/DataSift/Storyplayer/functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
  * this function avoids reset()ing the array, so it will not mess with
  * any iteration that you may currently be part-way through
  *
- * @param  array $arrayToSearch
+ * @param  Storyplayer\TestEnvironments\ProvisioningAdapter[] $arrayToSearch
  *         the array to get the first element of
  * @return mixed
  *         the first element of $array, or NULL if the array is empty
@@ -95,7 +95,7 @@ 
 /**
  * Create a new test environment object
  *
- * @return TestEnvironment
+ * @return TestEnvironment_Definition
  *         the test environment object to use in the script
  */
 function newTestEnvironment()

src/php/DataSift/Storyplayer/OutputLib/CodeParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
 
     /**
      * @param  string $filename
-     * @return bool
+     * @return null|boolean
      */
     public function buildParseTreeForFile($filename)
     {

src/php/DataSift/Storyplayer/PlayerLib/StoryTeller.php

Doc Comments +12 added lines, -1 removed lines

@@ -438,6 +438,7 @@ 
     }
 
     /**
+     * @param Prose_Loader $proseLoader
      * @return void
      */
     public function setProseLoader($proseLoader)
@@ -454,6 +455,9 @@ 
         return $this->phaseLoader;
     }
 
+    /**
+     * @param Phase_Loader $phaseLoader
+     */
     public function setPhaseLoader($phaseLoader)
     {
         $this->phaseLoader = $phaseLoader;
@@ -483,11 +487,17 @@ 
         return $this->codeParser;
     }
 
+    /**
+     * @param \DataSift\Storyplayer\OutputLib\CodeParser $codeParser
+     */
     public function setCodeParser($codeParser)
     {
         $this->codeParser = $codeParser;
     }
 
+    /**
+     * @param \DataSift\Storyplayer\OutputLib\DataFormatter $dataFormatter
+     */
     public function setDataFormatter($dataFormatter)
     {
         $this->dataFormatter = $dataFormatter;
@@ -520,6 +530,7 @@ 
     }
 
     /**
+     * @param \DataSift\Storyplayer\ConfigLib\ActiveConfig $config
      * @return void
      */
     public function setConfig($config)
@@ -783,7 +794,7 @@ 
      *
      * @param  string $methodName
      * @param  array  $methodArgs
-     * @return mixed
+     * @return \Prose\Prose
      */
     public function __call($methodName, $methodArgs)
     {

src/php/DataSift/Storyplayer/Reports/TapReport.php

Doc Comments -1 removed lines

@@ -177,7 +177,6 @@
     }
 
     /**
-     * @param integer $level
      * @param string $msg
      * @return void
      */

src/php/Prose/BaseCleanup.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
      * __construct
      *
      * @param StoryTeller $st The StoryTeller object
-     * @param array $args Any arguments to be used in this Prose module
+     * @param string[] $args Any arguments to be used in this Prose module
      *
      * @return parent::__construct
      */