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/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

@@ -59,7 +59,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
      */

src/php/DataSift/Storyplayer/Cli/RuntimeConfigManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -134,7 +134,7 @@
      * a separate config file for each test environment. The original
      * runtime-v2.json file is then deleted from disk.
      *
-     * @param  BaseObject $config
+     * @param BaseObject $oldConfig
      * @return void
      */
     protected function splitUpConfig($oldConfig)

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

Doc Comments +8 added lines, -3 removed lines

@@ -90,6 +90,9 @@ 
 
     /**
      * constructor
+     * @param string $configType
+     * @param string[] $searchFolders
+     * @param ConfigFinder[] $configFinders
      */
     public function __construct($configType, $searchFolders, $configFinders)
     {
@@ -186,6 +189,7 @@ 
     /**
      * load a SPv2.0-style JSON configs
      *
+     * @param string $filename
      * @return object
      */
     protected function loadJsonConfig($filename)
@@ -204,7 +208,8 @@ 
      * @todo we need (at some point) to move the check for a return value
      *       out to somewhere else
      *
-     * @return object
+     * @param string $filename
+     * @return TestEnvironment_Definition
      */
     protected function loadPhpConfig($filename)
     {
@@ -360,7 +365,7 @@ 
     /**
      * returns our list of all known configs
      *
-     * @return array
+     * @return SystemUnderTestConfig[]
      */
     public function getEntries()
     {
@@ -370,7 +375,7 @@ 
     /**
      * returns the names of all of the entries in our list
      *
-     * @return array<string>
+     * @return integer[]
      */
     public function getEntryNames()
     {

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

Doc Comments +11 added lines, -2 removed lines

@@ -429,6 +429,7 @@ 
     }
 
     /**
+     * @param Prose_Loader $proseLoader
      * @return void
      */
     public function setProseLoader($proseLoader)
@@ -445,6 +446,9 @@ 
         return $this->phaseLoader;
     }
 
+    /**
+     * @param Phase_Loader $phaseLoader
+     */
     public function setPhaseLoader($phaseLoader)
     {
         $this->phaseLoader = $phaseLoader;
@@ -469,6 +473,9 @@ 
         $this->output = $output;
     }
 
+    /**
+     * @param \DataSift\Storyplayer\OutputLib\DataFormatter $dataFormatter
+     */
     public function setDataFormatter($dataFormatter)
     {
         $this->dataFormatter = $dataFormatter;
@@ -501,6 +508,7 @@ 
     }
 
     /**
+     * @param \DataSift\Storyplayer\ConfigLib\ActiveConfig $config
      * @return void
      */
     public function setConfig($config)
@@ -509,7 +517,7 @@ 
     }
 
     /**
-     * @return object
+     * @return \DataSift\Storyplayer\TestEnvironmentsLib\TestEnvironmentRuntimeConfig
      */
     public function getRuntimeConfig()
     {
@@ -517,6 +525,7 @@ 
     }
 
     /**
+     * @param \DataSift\Storyplayer\TestEnvironmentsLib\TestEnvironmentRuntimeConfig $runtimeConfig
      * @return void
      */
     public function setRuntimeConfig($runtimeConfig)
@@ -764,7 +773,7 @@ 
      *
      * @param  string $methodName
      * @param  array  $methodArgs
-     * @return mixed
+     * @return \Prose\Prose
      */
     public function __call($methodName, $methodArgs)
     {

src/php/DataSift/Storyplayer/PlayerLib/Story.php

Doc Comments +1 added lines

@@ -700,6 +700,7 @@
     }
 
     /**
+     * @param integer $version
      * @return Story
      */
     public function requiresStoryplayerVersion($version)

src/php/DataSift/Storyplayer/OutputLib/OutputWriter.php

Doc Comments +6 added lines

@@ -128,6 +128,9 @@ 
         ];
     }
 
+    /**
+     * @param string $filename
+     */
     public function addOutputToFile($filename)
     {
         // can we open the file?
@@ -169,6 +172,9 @@ 
     //
     // ------------------------------------------------------------------
 
+    /**
+     * @param integer $mode
+     */
     public function setColourMode($mode)
     {
         switch ($mode)

src/php/DataSift/Storyplayer/Console/Console.php

Doc Comments +2 added lines, -1 removed lines

@@ -92,7 +92,8 @@
     /**
      * called when Storyplayer exits
      *
-     * @return void
+     * @param boolean $summary
+     * @return integer
      */
     public function writeFinalReport($duration, $summary)
     {