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/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/Reports/TapReport.php

Doc Comments -1 removed lines

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

src/php/Storyplayer/TestEnvironments/Vagrant/VirtualboxHostAdapter.php

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
 	 *         the group that we belong to
 	 * @param  string $hostId
 	 *         the alias for this host
-	 * @return object
+	 * @return Vagrant_VirtualboxHostDefinition
 	 *         a host definition to populate
 	 */
 	public function newHostDefinition(TestEnvironment_GroupDefinition $groupDef, $hostId)

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()
     {