phpdoc fixes
authorEileen McNaughton <eileen@fuzion.co.nz>
Mon, 12 Jan 2015 22:34:57 +0000 (11:34 +1300)
committerEileen McNaughton <eileen@fuzion.co.nz>
Mon, 12 Jan 2015 22:34:57 +0000 (11:34 +1300)
38 files changed:
tests/phpunit/CRM/Contact/BAO/GroupContactCacheTest.php
tests/phpunit/CRM/Contact/BAO/QueryTest.php
tests/phpunit/CRM/Contact/Form/Search/Custom/GroupTest.php
tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php
tests/phpunit/CRM/Core/DAOTest.php
tests/phpunit/CRM/Core/Smarty/plugins/CrmScopeTest.php
tests/phpunit/CRM/Core/TransactionTest.php
tests/phpunit/CRM/Mailing/BAO/QueryTest.php
tests/phpunit/CRM/Queue/Queue/SqlTest.php
tests/phpunit/CRM/Queue/QueueTest.php
tests/phpunit/CRM/Report/Form/Contribute/DetailTest.php
tests/phpunit/CRM/Report/Form/TestCaseTest.php
tests/phpunit/CRM/Utils/RuleTest.php
tests/phpunit/CRM/Utils/StringTest.php
tests/phpunit/CRM/Utils/TypeTest.php
tests/phpunit/Civi/API/KernelTest.php
tests/phpunit/Civi/API/RequestTest.php
tests/phpunit/Civi/API/Subscriber/TransactionSubscriberTest.php
tests/phpunit/CiviTest/CiviDBAssert.php
tests/phpunit/CiviTest/CiviMailUtils.php
tests/phpunit/CiviTest/CiviSeleniumTestCase.php
tests/phpunit/CiviTest/CiviTestSuite.php
tests/phpunit/CiviTest/CiviUnitTestCase.php
tests/phpunit/CiviTest/Membership.php
tests/phpunit/Utils.php
tests/phpunit/WebTest/Contact/MergeContactsTest.php
tests/phpunit/WebTest/Contact/MultipleContactSubTypes.php
tests/phpunit/WebTest/Contact/SearchBuilderTest.php
tests/phpunit/WebTest/Contact/SearchTest.php
tests/phpunit/WebTest/Contact/SignatureTest.php
tests/phpunit/WebTest/Profile/MultiRecordProfileAddTest.php
tests/phpunit/WebTest/Utils/RestTest.php
tests/phpunit/api/v3/ACLPermissionTest.php
tests/phpunit/api/v3/AllTests.php
tests/phpunit/api/v3/ContributionTest.php
tests/phpunit/api/v3/RelationshipTypeTest.php
tests/phpunit/api/v3/ReportTemplateTest.php
tests/phpunit/api/v3/SyntaxConformanceTest.php

index 76561d3ede34b84b8b2bfc900bdf4681529053b7..a9374611acb41cd2a1fb20adfdc355a9ab29185a 100644 (file)
@@ -219,6 +219,10 @@ class CRM_Contact_BAO_GroupContactCacheTest extends CiviUnitTestCase {
    * created entities and provides for brainless clenaup.
    *
    * @see CRM_Core_DAO::createTestObject
+   * @param $daoName
+   * @param array $params
+   * @param int $numObjects
+   * @param bool $createOnly
    */
   function createTestObject($daoName, $params = array(), $numObjects = 1, $createOnly = FALSE) {
     $objects = CRM_Core_DAO::createTestObject($daoName, $params, $numObjects, $createOnly);
index 0e240b35002cd18cc13836d066c58e4ab51cf282..d96bc27c5a45958c3a9aad77c691088f3b437f54 100644 (file)
@@ -33,6 +33,10 @@ class CRM_Contact_BAO_QueryTest extends CiviUnitTestCase {
   /**
    *  Test CRM_Contact_BAO_Query::searchQuery()
    * @dataProvider dataProvider
+   * @param $fv
+   * @param $count
+   * @param $ids
+   * @param $full
    */
   public function testSearch($fv, $count, $ids, $full) {
     $op = new PHPUnit_Extensions_Database_Operation_Insert();
index e76b78e8cdce10be42effc4f5e8205f5b4721db3..e24db3a3aa102ddaadb00fea15ce8855322e7720 100644 (file)
@@ -82,6 +82,11 @@ class CRM_Contact_Form_Search_Custom_GroupTest extends CiviUnitTestCase {
   /**
    *  Test CRM_Contact_Form_Search_Custom_Group::count()
    * @dataProvider dataProvider
+   * @param $fv
+   * @param $count
+   * @param $ids
+   * @param $full
+   * @throws \Exception
    */
   public function testCount($fv, $count, $ids, $full) {
     $this->foreignKeyChecksOff();
@@ -114,6 +119,11 @@ class CRM_Contact_Form_Search_Custom_GroupTest extends CiviUnitTestCase {
   /**
    *  Test CRM_Contact_Form_Search_Custom_Group::all()
    * @dataProvider dataProvider
+   * @param $fv
+   * @param $count
+   * @param $ids
+   * @param $full
+   * @throws \Exception
    */
   public function testAll($fv, $count, $ids, $full) {
     // Truncate affected tables
@@ -145,6 +155,11 @@ class CRM_Contact_Form_Search_Custom_GroupTest extends CiviUnitTestCase {
   /**
    *  Test CRM_Contact_Form_Search_Custom_Group::contactIDs()
    * @dataProvider dataProvider
+   * @param $fv
+   * @param $count
+   * @param $ids
+   * @param $full
+   * @throws \Exception
    */
   public function testContactIDs($fv, $count, $ids, $full) {
     // Truncate affected tables
index a762f5b3c786dc13272afe0dd0f5dfd6bff8c8ba..76f4a7bd5f21b562ef20245e0f02f379eaf907f4 100644 (file)
@@ -891,6 +891,10 @@ class CRM_Core_BAO_ActionScheduleTest extends CiviUnitTestCase {
    * created entities and provides for brainless clenaup.
    *
    * @see CRM_Core_DAO::createTestObject
+   * @param $daoName
+   * @param array $params
+   * @param int $numObjects
+   * @param bool $createOnly
    */
   function createTestObject($daoName, $params = array(), $numObjects = 1, $createOnly = FALSE) {
     $objects = CRM_Core_DAO::createTestObject($daoName, $params, $numObjects, $createOnly);
index 204eb317a084ac365f23aff88c2b67507f8a03e0..fd4cce327c0610a3d446ac9578247942a33e541e 100644 (file)
@@ -133,6 +133,9 @@ class CRM_Core_DAOTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider composeQueryExamples
+   * @param $inputSql
+   * @param $inputParams
+   * @param $expectSql
    */
   public function testComposeQuery($inputSql, $inputParams, $expectSql) {
     $actualSql = CRM_Core_DAO::composeQuery($inputSql, $inputParams);
@@ -195,6 +198,10 @@ class CRM_Core_DAOTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider sqlNameDataProvider
+   * @param $inputData
+   * @param $length
+   * @param $makeRandom
+   * @param $expectedResult
    */
   public function testShortenSQLName($inputData, $length, $makeRandom, $expectedResult) {
     $this->assertEquals($expectedResult, CRM_Core_DAO::shortenSQLName($inputData, $length, $makeRandom));
index 379ae8961c6b8321bef8f2d58406e3c34b2fca06..7c6efc32b69d6c1d04305c72377bbdd224fb88f1 100644 (file)
@@ -41,6 +41,8 @@ class CRM_Core_Smarty_plugins_CrmScopeTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider scopeCases
+   * @param $expected
+   * @param $input
    */
   public function testBlank($expected, $input) {
     $smarty = CRM_Core_Smarty::singleton();
index ee1a55118042a4f5f2c2da149a33149984cae0a5..980d0ae60d72e48a6cb9cedf06b0100185023cb0 100644 (file)
@@ -58,6 +58,7 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider dataCreateStyle
+   * @param $createStyle
    */
   public function testBasicRollback($createStyle) {
     $this->createContactWithTransaction('reuse-tx', $createStyle, 'rollback');
index 488aff6aa541f0ea71766b4f30f770cae9b40a2e..0052ed6483b073ce871b214062ea7ac91a3f3209 100644 (file)
@@ -39,6 +39,10 @@ class CRM_Mailing_BAO_QueryTest extends CiviUnitTestCase {
   /**
    *  Test CRM_Contact_BAO_Query::searchQuery()
    * @dataProvider dataProvider
+   * @param $fv
+   * @param $count
+   * @param $ids
+   * @param $full
    */
   public function testSearch($fv, $count, $ids, $full) {
     $op = new PHPUnit_Extensions_Database_Operation_Insert();
index d85b8e8b0b69d7e8c79495d5ff57bdb4069ec71e..fe67bbbef8ed6e3c593e6ac5017a626b4f6c9211 100644 (file)
@@ -70,6 +70,7 @@ class CRM_Queue_Queue_SqlTest extends CiviUnitTestCase {
    * Create a few queue items; alternately enqueue and dequeue various
    *
    * @dataProvider getQueueSpecs
+   * @param $queueSpec
    */
   public function testPriorities($queueSpec) {
     $this->queue = $this->queueService->create($queueSpec);
index ab8d4404deea1d31e2dc761a66322ca72e983199..24c49021315223275a9d698102f16141f4c9a511 100644 (file)
@@ -74,6 +74,7 @@ class CRM_Queue_QueueTest extends CiviUnitTestCase {
    * Create a few queue items; alternately enqueue and dequeue various
    *
    * @dataProvider getQueueSpecs
+   * @param $queueSpec
    */
   public function testBasicUsage($queueSpec) {
     $this->queue = $this->queueService->create($queueSpec);
@@ -120,6 +121,7 @@ class CRM_Queue_QueueTest extends CiviUnitTestCase {
    * Claim an item from the queue and release it back for subsequent processing
    *
    * @dataProvider getQueueSpecs
+   * @param $queueSpec
    */
   public function testManualRelease($queueSpec) {
     $this->queue = $this->queueService->create($queueSpec);
@@ -146,6 +148,7 @@ class CRM_Queue_QueueTest extends CiviUnitTestCase {
    * Test that item leases expire at the expected time
    *
    * @dataProvider getQueueSpecs
+   * @param $queueSpec
    */
   public function testTimeoutRelease($queueSpec) {
     $this->queue = $this->queueService->create($queueSpec);
@@ -180,6 +183,7 @@ class CRM_Queue_QueueTest extends CiviUnitTestCase {
    * Test that item leases can be ignored
    *
    * @dataProvider getQueueSpecs
+   * @param $queueSpec
    */
   public function testStealItem($queueSpec) {
     $this->queue = $this->queueService->create($queueSpec);
@@ -214,6 +218,7 @@ class CRM_Queue_QueueTest extends CiviUnitTestCase {
    * Test that queue content is reset when reset=>TRUE
    *
    * @dataProvider getQueueSpecs
+   * @param $queueSpec
    */
   public function testCreateResetTrue($queueSpec) {
     $this->queue = $this->queueService->create($queueSpec);
@@ -236,6 +241,7 @@ class CRM_Queue_QueueTest extends CiviUnitTestCase {
    * Test that queue content is not reset when reset is omitted
    *
    * @dataProvider getQueueSpecs
+   * @param $queueSpec
    */
   public function testCreateResetFalse($queueSpec) {
     $this->queue = $this->queueService->create($queueSpec);
@@ -260,6 +266,7 @@ class CRM_Queue_QueueTest extends CiviUnitTestCase {
    * Test that queue content is not reset when using load()
    *
    * @dataProvider getQueueSpecs
+   * @param $queueSpec
    */
   public function testLoad($queueSpec) {
     $this->queue = $this->queueService->create($queueSpec);
index 6a194b8d5fb53469328a471315e1f79505b93a23..9ba0b8537060e169a599d5aacb2ba2a707873940 100644 (file)
@@ -82,6 +82,11 @@ class CRM_Report_Form_Contribute_DetailTest extends CiviReportTestCase {
 
   /**
    * @dataProvider dataProvider
+   * @param $reportClass
+   * @param $inputParams
+   * @param $dataSet
+   * @param $expectedOutputCsvFile
+   * @throws \Exception
    */
   public function testReportOutput($reportClass, $inputParams, $dataSet, $expectedOutputCsvFile) {
     $config = CRM_Core_Config::singleton();
index a6629ab37a3d99a6eb9a7645c54f37feed22ba9d..4c0438720a924a86246829570bb15a565a5c8296 100644 (file)
@@ -144,6 +144,11 @@ class CRM_Report_Form_TestCaseTest extends CiviReportTestCase {
 
   /**
    * @dataProvider dataProvider
+   * @param $reportClass
+   * @param $inputParams
+   * @param $dataSet
+   * @param $expectedOutputCsvFile
+   * @throws \Exception
    */
   public function testReportOutput($reportClass, $inputParams, $dataSet, $expectedOutputCsvFile) {
     $config = CRM_Core_Config::singleton();
@@ -159,6 +164,11 @@ class CRM_Report_Form_TestCaseTest extends CiviReportTestCase {
   /**
    * @expectedException PHPUnit_Framework_AssertionFailedError
    * @dataProvider badDataProvider
+   * @param $reportClass
+   * @param $inputParams
+   * @param $dataSet
+   * @param $expectedOutputCsvFile
+   * @throws \Exception
    */
   public function testBadReportOutput($reportClass, $inputParams, $dataSet, $expectedOutputCsvFile) {
     $config = CRM_Core_Config::singleton();
index dbd31b7fbc427e9487201d1446ea7b95da6049fa..d3be0ee46c0af070f5807283179ee2b84b7c4c54 100644 (file)
@@ -13,6 +13,8 @@ class CRM_Utils_RuleTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider integerDataProvider
+   * @param $inputData
+   * @param $expectedResult
    */
   public function testInteger($inputData, $expectedResult) {
     $this->assertEquals($expectedResult, CRM_Utils_Rule::integer($inputData));
@@ -34,6 +36,8 @@ class CRM_Utils_RuleTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider positiveDataProvider
+   * @param $inputData
+   * @param $expectedResult
    */
   public function testPositive($inputData, $expectedResult) {
     $this->assertEquals($expectedResult, CRM_Utils_Rule::positiveInteger($inputData));
@@ -55,6 +59,8 @@ class CRM_Utils_RuleTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider numericDataProvider
+   * @param $inputData
+   * @param $expectedResult
    */
   public function testNumeric($inputData, $expectedResult) {
     $this->assertEquals($expectedResult, CRM_Utils_Rule::numeric($inputData));
index 41acb07624400b7cd47ebd5636017aea301f9823..e92a8ad94fede3317eeb276a1faf4d2c795600d2 100644 (file)
@@ -114,6 +114,9 @@ class CRM_Utils_StringTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider parsePrefixData
+   * @param $input
+   * @param $defaultPrefix
+   * @param $expected
    */
   public function testParsePrefix($input, $defaultPrefix, $expected) {
     $actual = CRM_Utils_String::parsePrefix(':', $input, $defaultPrefix);
index 301136e2b5668eed8e54628ada49fad7081f3785..923bbe27c49b36b35425124517c51dd3af89fa66 100644 (file)
@@ -13,6 +13,9 @@ class CRM_Utils_TypeTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider validateDataProvider
+   * @param $inputData
+   * @param $inputType
+   * @param $expectedResult
    */
   public function testValidate($inputData, $inputType, $expectedResult) {
     $this->assertEquals($expectedResult, CRM_Utils_Type::validate($inputData, $inputType, FALSE));
index 0d429b2740c35cb653cd23cf3b898ed3301aa42f..ab1cebd0354926a04f1e875b141335f610df6c29 100644 (file)
@@ -95,7 +95,6 @@ class KernelTest extends \CiviUnitTestCase {
    * @param array $monitoredEvents
    *   List of event names.
    *
-   * @internal param \Symfony\Component\EventDispatcher\EventDispatcher $this ->dispatcher
    */
   public function monitorEvents($monitoredEvents) {
     foreach ($monitoredEvents as $monitoredEvent) {
index f9b7ac1c72a963c79a8dcb111a6d434c1d275858..f2e068f6188dd079e1e8bd3539bac268e6f2cf27 100644 (file)
@@ -135,6 +135,9 @@ class RequestTest extends \CiviUnitTestCase {
 
   /**
    * @dataProvider validEntityActionPairs
+   * @param $input
+   * @param $expected
+   * @throws \API_Exception
    */
   public function testCreateRequest_EntityActionMunging($input, $expected) {
     list ($inEntity, $inAction, $inVersion) = $input;
@@ -159,6 +162,10 @@ class RequestTest extends \CiviUnitTestCase {
   /**
    * @dataProvider invalidEntityActionPairs
    * @expectedException \API_Exception
+   * @param $inEntity
+   * @param $inAction
+   * @param $inVersion
+   * @throws \API_Exception
    */
   public function testCreateRequest_InvalidEntityAction($inEntity, $inAction, $inVersion) {
     Request::create($inEntity, $inAction, array('version' => $inVersion), NULL);
index 58d76d6bc45856d2dcccb4a6f322dc39656fa148..684f30463e16363d01f5f5ea71e1ab2a7132b111 100644 (file)
@@ -80,6 +80,14 @@ class TransactionSubscriberTest extends \CiviUnitTestCase {
   /**
    * Ensure that API parameters "is_transactional" and "force_rollback" are parsed correctly
    * @dataProvider transactionOptions
+   * @param $version
+   * @param $entity
+   * @param $action
+   * @param $params
+   * @param $isTransactional
+   * @param $isForceRollback
+   * @param $isNested
+   * @throws \API_Exception
    */
   public function testTransactionOptions($version, $entity, $action, $params, $isTransactional, $isForceRollback, $isNested) {
     $txs = new TransactionSubscriber();
index ba415c81e077edf4377bc5c7e2c2a6cc86cd8c37..ff12960746175a26e09d70927c411ec8a3ea75ca 100644 (file)
@@ -43,6 +43,11 @@ class CiviDBAssert {
    * @match    array    Associative array of field name => expected value. Empty if asserting
    *                      that a DELETE occurred
    * @delete   boolean  True if we're checking that a DELETE action occurred.
+   * @param $testCase
+   * @param $daoName
+   * @param $id
+   * @param $match
+   * @param bool $delete
    */
   public function assertDBState(&$testCase, $daoName, $id, $match, $delete = FALSE) {
     if (empty($id)) {
@@ -90,6 +95,13 @@ class CiviDBAssert {
 
   /**
    * Request a record from the DB by seachColumn+searchValue. Success if a record is found.
+   * @param $testCase
+   * @param $daoName
+   * @param $searchValue
+   * @param $returnColumn
+   * @param $searchColumn
+   * @param $message
+   * @return null|string
    */
   public function assertDBNotNull(&$testCase, $daoName, $searchValue, $returnColumn, $searchColumn, $message) {
     if (empty($searchValue)) {
@@ -103,6 +115,12 @@ class CiviDBAssert {
 
   /**
    * Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
+   * @param $testCase
+   * @param $daoName
+   * @param $searchValue
+   * @param $returnColumn
+   * @param $searchColumn
+   * @param $message
    */
   public function assertDBNull(&$testCase, $daoName, $searchValue, $returnColumn, $searchColumn, $message) {
     $value = CRM_Core_DAO::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn);
@@ -111,6 +129,10 @@ class CiviDBAssert {
 
   /**
    * Request a record from the DB by id. Success if row not found.
+   * @param $testCase
+   * @param $daoName
+   * @param $id
+   * @param $message
    */
   public function assertDBRowNotExist(&$testCase, $daoName, $id, $message) {
     $value = CRM_Core_DAO::getFieldValue($daoName, $id, 'id', 'id');
@@ -138,6 +160,10 @@ class CiviDBAssert {
 
   /**
    * Compare all values in a single retrieved DB record to an array of expected values
+   * @param $testCase
+   * @param $daoName
+   * @param $searchParams
+   * @param $expectedValues
    */
   public function assertDBCompareValues(&$testCase, $daoName, $searchParams, $expectedValues) {
     //get the values from db
index 73b147297fafbea8a9511339eb26f46947621bed..8eda18b962be8a22c011cc4ded54c79e3079f5ee 100644 (file)
@@ -271,6 +271,7 @@ class CiviMailUtils extends PHPUnit_Framework_TestCase {
 
   /**
    * Check that mail log is empty
+   * @param string $prefix
    */
   public function assertMailLogEmpty($prefix = '') {
     $mail = $this->getMostRecentEmail('raw');
index 8f80e4aa0400558348bac009098c4b601e1f6c60..9b708b70dd657608c72e2a85800fd143116cd9a2 100644 (file)
@@ -229,6 +229,9 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
    * Click on a link or button
    * Wait for the page to load
    * Wait for an element to be present
+   * @param $element
+   * @param string $waitFor
+   * @param bool $waitForPageLoad
    */
   public function clickLink($element, $waitFor = 'civicrm-footer', $waitForPageLoad = TRUE) {
     $this->click($element);
@@ -298,6 +301,10 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
   /**
    * Call the API on the local server
    * (kind of defeats the point of a webtest - see CRM-11889)
+   * @param $entity
+   * @param $action
+   * @param $params
+   * @return array|int
    */
   public function webtest_civicrm_api($entity, $action, $params) {
     if (!isset($params['version'])) {
@@ -313,6 +320,10 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
    * Call the API on the remote server
    * Experimental - currently only works if permissions on remote site allow anon user to access ajax api
    * @see CRM-11889
+   * @param $entity
+   * @param $action
+   * @param array $params
+   * @return mixed
    */
   public function rest_civicrm_api($entity, $action, $params = array()) {
     $params += array(
@@ -392,6 +403,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
 
   /**
    * Ensures the required CiviCRM components are enabled
+   * @param $components
    */
   public function enableComponents($components) {
     $this->openCiviPage("admin/setting/component", "reset=1", "_qf_Component_next-bottom");
@@ -493,6 +505,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
   }
 
   /**
+   * @param $sortName
+   * @param string $fieldName
    */
   public function webtestFillAutocomplete($sortName, $fieldName = 'contact_id') {
     $this->select2($fieldName, $sortName);
@@ -500,6 +514,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
   }
 
   /**
+   * @param $sortName
    */
   public function webtestOrganisationAutocomplete($sortName) {
     $this->clickAt("//*[@id='contact_id']/../div/a");
@@ -596,7 +611,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
    * @param string $editor
    *   Which text editor (valid values are 'CKEditor', 'TinyMCE').
    *
-   * @return void
+   * @param bool $compressed
+   * @throws \PHPUnit_Framework_AssertionFailedError
    */
   public function fillRichTextField($fieldName, $text = 'Typing this text into editor.', $editor = 'CKEditor', $compressed = FALSE) {
     // make sure cursor focuses on the field
@@ -684,6 +700,13 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
 
   /**
    * @deprecated in favor of createDialogContact
+   * @param string $fname
+   * @param string $lname
+   * @param string $email
+   * @param int $type
+   * @param string $selectId
+   * @param int $row
+   * @param string $prefix
    */
   function webtestNewDialogContact(
     $fname = 'Anthony', $lname = 'Anderson', $email = 'anthony@anderson.biz',
@@ -762,6 +785,9 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
 
   /**
    * Returns a single argument from the url query
+   * @param $arg
+   * @param null $url
+   * @return null
    */
   public function urlArg($arg, $url = NULL) {
     $elements = $this->parseURL($url);
@@ -1037,7 +1063,6 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
    * @param string $financialType
    * @param bool $fixedAmount
    * @param bool $membershipsRequired
-   * @internal param \can $User define pageTitle, hash and rand values for later data verification
    *
    * @return null
    *   of newly created online contribution page.
@@ -1786,6 +1811,17 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
 
   /**
    * Edit Financial Account
+   * @param $editfinancialAccount
+   * @param bool $financialAccountTitle
+   * @param bool $financialAccountDescription
+   * @param bool $accountingCode
+   * @param bool $firstName
+   * @param bool $financialAccountType
+   * @param bool $taxDeductible
+   * @param bool $isActive
+   * @param bool $isTax
+   * @param bool $taxRate
+   * @param bool $isDefault
    */
   function _testEditFinancialAccount(
     $editfinancialAccount,
@@ -1874,6 +1910,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
 
   /**
    * Delete Financial Account
+   * @param $financialAccountTitle
    */
   public function _testDeleteFinancialAccount($financialAccountTitle) {
     $this->click("xpath=//table/tbody//tr/td[1]/div[text()='{$financialAccountTitle}']/../../td[9]/span/a[text()='Delete']");
@@ -1885,6 +1922,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
 
   /**
    * Verify data after ADD and EDIT
+   * @param $verifyData
    */
   public function _assertFinancialAccount($verifyData) {
     foreach ($verifyData as $key => $expectedValue) {
@@ -1964,6 +2002,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
   /**
    * Give the specified permissions
    * Note: this function logs in as 'admin' (logging out if necessary)
+   * @param $permission
    */
   public function changePermissions($permission) {
     $this->webtestLogin('admin');
@@ -2203,6 +2242,10 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
 
   /**
    * Type and select first occurance of autocomplete
+   * @param $fieldName
+   * @param $label
+   * @param bool $multiple
+   * @param bool $xpath
    */
   public function select2($fieldName, $label, $multiple = FALSE, $xpath = FALSE) {
     // In the case of chainSelect, wait for options to load
@@ -2235,6 +2278,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
 
   /**
    * Select multiple options
+   * @param $fieldid
+   * @param $params
    */
   public function multiselect2($fieldid, $params) {
     // In the case of chainSelect, wait for options to load
@@ -2251,6 +2296,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
 
   /**
    * Check for unobtrusive status message as set by CRM.status
+   * @param null $text
    */
   public function checkCRMStatus($text = NULL) {
     $this->waitForElementPresent("css=.crm-status-box-outer.status-success");
@@ -2261,6 +2307,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase {
 
   /**
    * Check for obtrusive status message as set by CRM.alert
+   * @param $text
+   * @param string $type
    */
   public function checkCRMAlert($text, $type = 'success') {
     $this->waitForElementPresent("css=div.ui-notify-message.$type");
index de3e081ad28bbd5ec5817fa37786729d7544f746..5c073aa057ef786c939b686143b132be02bca664 100644 (file)
@@ -40,6 +40,8 @@ class CiviTestSuite extends PHPUnit_Framework_TestSuite {
 
   /**
    * Simple name based constructor
+   * @param string $theClass
+   * @param string $name
    */
   public function __construct($theClass = '', $name = '') {
     if (empty($name)) {
@@ -80,6 +82,8 @@ class CiviTestSuite extends PHPUnit_Framework_TestSuite {
   }
 
   /**
+   * @param $myfile
+   * @return \PHPUnit_Framework_TestSuite
    */
   protected function implSuite($myfile) {
     $name = str_replace('_',
index 696f38329ab97ae399d5dc94d4dd0bd1b3106b57..04299f181fe84622584945baedccb29224e7ffe1 100755 (executable)
@@ -562,6 +562,11 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
    * @match    array    Associative array of field name => expected value. Empty if asserting
    *                      that a DELETE occurred
    * @delete   boolean  True if we're checking that a DELETE action occurred.
+   * @param $daoName
+   * @param $id
+   * @param $match
+   * @param bool $delete
+   * @throws \PHPUnit_Framework_AssertionFailedError
    */
   public function assertDBState($daoName, $id, $match, $delete = FALSE) {
     if (empty($id)) {
@@ -705,6 +710,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
    *
    * Example: $this->assertSql(2, 'select count(*) from foo where foo.bar like "%1"',
    * array(1 => array("Whiz", "String")));
+   * @param $expected
+   * @param $query
+   * @param array $params
+   * @param string $message
    */
   public function assertDBQuery($expected, $query, $params = array(), $message = '') {
     if ($message) {
@@ -850,6 +859,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
 
   /**
    * Check that a deleted item has been deleted
+   * @param $entity
+   * @param $id
    */
   public function assertAPIDeleted($entity, $id) {
     $this->callAPISuccess($entity, 'getcount', array('id' => $id), 0);
@@ -2060,6 +2071,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
   /**
    * Existing function doesn't allow params to be over-ridden so need a new one
    * this one allows you to only pass in the params you want to change
+   * @param array $params
+   * @return array|int
    */
   public function CustomGroupCreateByParams($params = array()) {
     $defaults = array(
@@ -2075,6 +2088,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
 
   /**
    * Create custom group with multi fields
+   * @param array $params
+   * @return array|int
    */
   public function CustomGroupMultipleCreateByParams($params = array()) {
     $defaults = array(
@@ -2087,6 +2102,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
 
   /**
    * Create custom group with multi fields
+   * @param array $params
+   * @return array
    */
   public function CustomGroupMultipleCreateWithFields($params = array()) {
     // also need to pass on $params['custom_field'] if not set but not in place yet
@@ -2752,6 +2769,7 @@ AND    ( TABLE_NAME LIKE 'civicrm_value_%' )
 
   /**
    * Temporarily replace the singleton extension with a different one
+   * @param \CRM_Extension_System $system
    */
   public function setExtensionSystem(CRM_Extension_System $system) {
     if ($this->origExtensionSystem == NULL) {
@@ -3080,6 +3098,8 @@ AND    ( TABLE_NAME LIKE 'civicrm_value_%' )
    * this parent class & we don't have a structure for that yet
    * There is another function to this effect on the PaypalPro test but it appears to be silently failing
    * & the best protection agains that is the functions this class affords
+   * @param array $params
+   * @return
    */
   public function paymentProcessorCreate($params = array()) {
     $params = array_merge(array(
index 91e8d50041cc1871bfbc3b237fa0836328a1bc5d..f6ec88e8c656b8cde7d487e01629b1785f160dde 100644 (file)
@@ -40,6 +40,9 @@ class Membership extends PHPUnit_Framework_Testcase {
 
   /**
    * Helper function to create membership block for contribution page
+   * @param $membershipType
+   * @param $contributionPageId
+   * @return $this
    */
   public function createMembershipBlock($membershipType, $contributionPageId) {
     $param = array(
@@ -67,6 +70,7 @@ class Membership extends PHPUnit_Framework_Testcase {
 
   /**
    * Helper function to delete the membership block
+   * @param $blcokId
    */
   public function deleteMembershipBlock($blcokId) {
     $dao = new CRM_Member_DAO_MembershipBlock();
index 51ac65e77d01c588dc9c72ad181dab13e255412b..cfc7d1dae4472f6163d1f9060f27bdf2e8d1e0f3 100644 (file)
@@ -44,6 +44,10 @@ class Utils {
 
   /**
    *  Construct an object for this database
+   * @param $host
+   * @param $port
+   * @param $user
+   * @param $pass
    */
   public function __construct($host, $port, $user, $pass) {
     try {
index de6285e06f57b08cd554ec27e85f0b2ff369ee4a..05d14983db57c5844aa2cf24af45df64b1417ed3 100644 (file)
@@ -639,6 +639,11 @@ class WebTest_Contact_MergeContactsTest extends CiviSeleniumTestCase {
 
   /**
    * Helper FN
+   * @param null $firstName
+   * @param null $lastName
+   * @param null $organizationName
+   * @param string $contactType
+   * @return array
    */
   public function _createContacts($firstName = NULL, $lastName = NULL, $organizationName = NULL, $contactType = 'Individual') {
     if ($contactType == 'Individual') {
@@ -730,6 +735,7 @@ class WebTest_Contact_MergeContactsTest extends CiviSeleniumTestCase {
   /**
    * Helper FN
    * to create new membership type
+   * @param $membershipOrganization
    */
   public function addMembershipType($membershipOrganization) {
     $this->openCiviPage("admin/member/membershipType", "reset=1&action=browse");
index 0bcbaba77f863dcb6ff9e8db35e775de26fc879e..f6e2af0cba86b2624ce626b2b9072da613f1b77b 100644 (file)
@@ -215,6 +215,8 @@ class WebTest_Contact_MultipleContactSubTypes extends CiviSeleniumTestCase {
 
   /**
    * Add custom fields for a contact sub-type
+   * @param $contactSubType
+   * @return array
    */
   public function _addCustomData($contactSubType) {
     $this->openCiviPage("admin/custom/group", "action=add&reset=1");
index d0215ef3263d8bb80c2b9df4b2a922aa7eff00d3..71fe3cb47b6cd421acd6ecd15c2d9d30fbf85a99 100644 (file)
@@ -238,6 +238,13 @@ class WebTest_Contact_SearchBuilderTest extends CiviSeleniumTestCase {
 
   /**
    * Enter form values in a Search Builder row
+   * @param $set
+   * @param $row
+   * @param $entity
+   * @param $field
+   * @param $loc
+   * @param $op
+   * @param string $value
    */
   public function enterValues($set, $row, $entity, $field, $loc, $op, $value = '') {
     if ($set > 1 && $row == 1) {
index 083ad8bdb4045005196a4c9c6224920e22f5f237..925833741084d66a03eada316a48b6366eb09b77 100644 (file)
@@ -155,6 +155,8 @@ class WebTest_Contact_SearchTest extends CiviSeleniumTestCase {
    * This code is reused with advanced search, hence the reference to $self
    *
    * @static
+   * @param string $tagName
+   * @param $self
    */
   public static function addTag($tagName = 'New Tag', $self) {
     $self->openCiviPage('admin/tag', array('reset' => 1, 'action' => 'add'), '_qf_Tag_next');
index 5967bc590a4b0e38b70a4c1c5cc927e57bc1733a..f9ce67df727884a1cd13b585586a00fd690d551c 100644 (file)
@@ -143,6 +143,7 @@ class WebTest_Contact_SignatureTest extends CiviSeleniumTestCase {
 
   /**
    * Helper function to select Editor.
+   * @param $editor
    */
   public function _selectEditor($editor) {
     $this->openCiviPage('admin/setting/preferences/display', 'reset=1');
@@ -158,6 +159,9 @@ class WebTest_Contact_SignatureTest extends CiviSeleniumTestCase {
 
   /**
    * Helper function for Check Signature in Editor.
+   * @param $fieldName
+   * @param $signature
+   * @param $editor
    */
   public function _checkSignature($fieldName, $signature, $editor) {
     if ($editor == 'CKEditor') {
@@ -174,6 +178,8 @@ class WebTest_Contact_SignatureTest extends CiviSeleniumTestCase {
 
   /**
    * Helper function for Check Signature in Activity.
+   * @param $subject
+   * @param $signature
    */
   public function _checkActivity($subject, $signature) {
     $this->openCiviPage('activity/search', 'reset=1', '_qf_Search_refresh');
index be7fe7b609a19802110ee61190ea99b300fbf1f9..9865fed2cbe03ccf104c8088941512b2d7c6a31a 100644 (file)
@@ -372,9 +372,9 @@ class WebTest_Profile_MultiRecordProfileAddTest extends CiviSeleniumTestCase {
 
   /**
    * @param string $context
-   * @param string $parentElement
-   *
+   * @param bool $dialog
    * @return mixed
+   *
    */
   public function _addRecords($context = 'Edit', $dialog = FALSE) {
     $params['text'] = 'text' . substr(sha1(rand()), 0, 3);
index 7de715130a021ab9bfa798efbf24e83bde8acfa3..4000c7ee8a27c8e897764d84fdb3a3a19c138ca5 100644 (file)
@@ -189,6 +189,8 @@ class WebTest_Utils_RestTest extends CiviSeleniumTestCase {
 
   /**
    * @dataProvider apiTestCases
+   * @param $query
+   * @param $is_error
    */
   public function testAPICalls($query, $is_error) {
     $client = CRM_Utils_HttpClient::singleton();
index 1cf86362b4fc37493859ce55dfe346a13b56a3a8..431adcfc3b1ca5c38b9e17a38fbf80e6ccb5fba7 100644 (file)
@@ -247,6 +247,7 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase {
   /**
    * @dataProvider entities
    * confirm that without check permissions we still get 2 contacts returned
+   * @param $entity
    */
   public function testEntitiesGetHookLimitingHookNoCheck($entity) {
     CRM_Core_Config::singleton()->userPermissionClass->permissions = array();
@@ -262,6 +263,7 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase {
   /**
    * @dataProvider entities
    * confirm that without check permissions we still get 2 entities returned
+   * @param $entity
    */
   public function testEntitiesGetCoreACLLimitingHookNoCheck($entity) {
     $this->setupCoreACL();
@@ -278,6 +280,8 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase {
   /**
    * @dataProvider entities
    * confirm that with check permissions we don't get entities
+   * @param $entity
+   * @throws \PHPUnit_Framework_IncompleteTestError
    */
   public function testEntitiesGetCoreACLLimitingCheck($entity) {
     $this->markTestIncomplete('this does not work in 4.4 but can be enabled in 4.5 or a security release of 4.4 including the important security fix CRM-14877');
@@ -294,6 +298,8 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase {
   /**
    * @dataProvider entities
    * Function tests that an empty where hook returns no results
+   * @param $entity
+   * @throws \PHPUnit_Framework_IncompleteTestError
    */
   public function testEntityGetNoResultsHook($entity) {
     $this->markTestIncomplete('hook acls only work with contacts so far');
@@ -315,6 +321,7 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase {
 
   /**
    * Create 2 entities
+   * @param $entity
    */
   public function setUpEntities($entity) {
     $baoObj = new CRM_Core_DAO();
@@ -329,6 +336,11 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase {
 
   /**
    * No results returned
+   * @param $type
+   * @param $tables
+   * @param $whereTables
+   * @param $contactID
+   * @param $where
    */
   public function aclWhereHookNoResults($type, &$tables, &$whereTables, &$contactID, &$where) {
   }
@@ -336,6 +348,11 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase {
   /**
    * All results returned
    * @implements CRM_Utils_Hook::aclWhereClause
+   * @param $type
+   * @param $tables
+   * @param $whereTables
+   * @param $contactID
+   * @param $where
    */
   public function aclWhereHookAllResults($type, &$tables, &$whereTables, &$contactID, &$where) {
     $where = " (1) ";
@@ -344,6 +361,11 @@ class api_v3_ACLPermissionTest extends CiviUnitTestCase {
   /**
    * Full results returned
    * @implements CRM_Utils_Hook::aclWhereClause
+   * @param $type
+   * @param $tables
+   * @param $whereTables
+   * @param $contactID
+   * @param $where
    */
   public function aclWhereOnlySecond($type, &$tables, &$whereTables, &$contactID, &$where) {
     $where = " contact_a.id > 1";
index 467ef7ffc49e6a11eba2309c2ed1663aced64dbd..ba828c6cc914427232f2f09031494b522f46306e 100644 (file)
@@ -45,6 +45,8 @@ class api_v3_AllTests extends CiviTestSuite {
 
   /**
    * Simple name based constructor
+   * @param string $theClass
+   * @param string $name
    */
   function __construct($theClass = '', $name = '') {
     parent::__construct($theClass, $name);
index 3edd7f027286ba5307b18d266e0750a003e72ca8..5fecd0634bd24c53f540a83afd5175925e7fa618 100644 (file)
@@ -1565,6 +1565,9 @@ class api_v3_ContributionTest extends CiviUnitTestCase {
   /**
    * This function does a GET & compares the result against the $params
    * Use as a double check on Creates
+   * @param $params
+   * @param $id
+   * @param int $delete
    */
   public function contributionGetnCheck($params, $id, $delete = 1) {
 
index 9d8a551648e4a7c1b9f1b8960763b0f73969fc47..9354fab545eeea634d7e61f41fbc30610bc02827 100644 (file)
@@ -322,6 +322,8 @@ class api_v3_RelationshipTypeTest extends CiviUnitTestCase {
 
   /**
    * Create relationship type.
+   * @param null $params
+   * @return mixed
    */
   public function _relationshipTypeCreate($params = NULL) {
     if (!is_array($params) || empty($params)) {
index 2ce2645a2afe0f7528dc1f90693c874d35825ffb..3e89285651db21494cf2e8660793f09b8fac9dc8 100644 (file)
@@ -136,6 +136,8 @@ class api_v3_ReportTemplateTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider getReportTemplates
+   * @param $reportID
+   * @throws \PHPUnit_Framework_IncompleteTestError
    */
   public function testReportTemplateGetRowsAllReports($reportID) {
     if (stristr($reportID, 'has existing issues')) {
@@ -148,6 +150,8 @@ class api_v3_ReportTemplateTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider getReportTemplates
+   * @param $reportID
+   * @throws \PHPUnit_Framework_IncompleteTestError
    */
   public function testReportTemplateGetStatisticsAllReports($reportID) {
     if (stristr($reportID, 'has existing issues')) {
index c2f96504ecb1c69fb3f84574a6e2621692d23413..30213f51bf6c99fa666da3aa34f5af0fa9a512c3 100644 (file)
@@ -361,6 +361,8 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
 
   /**
    * At this stage exclude the ones that don't pass & add them as we can troubleshoot them
+   * @param bool $sequential
+   * @return array
    */
   public static function toBeSkipped_updatesingle($sequential = FALSE) {
     $entitiesWithout = array(
@@ -581,6 +583,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
   /**
    * @dataProvider toBeSkipped_get
   entities that don't need a get action
+   * @param $Entity
    */
   public function testNotImplemented_get($Entity) {
     $result = civicrm_api($Entity, 'Get', array('version' => 3));
@@ -592,6 +595,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
   /**
    * @dataProvider entities
    * @expectedException PHPUnit_Framework_Error
+   * @param $Entity
    */
   public function testWithoutParam_get($Entity) {
     // should get php complaining that a param is missing
@@ -600,6 +604,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider entities
+   * @param $Entity
    */
   public function testGetFields($Entity) {
     if (in_array($Entity, $this->deprecatedAPI) || $Entity == 'Entity' || $Entity == 'CustomValue') {
@@ -615,6 +620,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider entities_get
+   * @param $Entity
    */
   public function testEmptyParam_get($Entity) {
 
@@ -629,6 +635,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider entities_get
+   * @param $Entity
    */
   public function testEmptyParam_getString($Entity) {
 
@@ -644,6 +651,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
   /**
    * @dataProvider entities_get
    * @Xdepends testEmptyParam_get // no need to test the simple if the empty doesn't work/is skipped. doesn't seem to work
+   * @param $Entity
    */
   public function testSimple_get($Entity) {
     // $this->markTestSkipped("test gives core error on test server (but not on our locals). Skip until we can get server to pass");
@@ -666,6 +674,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider custom_data_entities_get
+   * @param $entityName
    */
   public function testCustomDataGet($entityName) {
     $this->createLoggedInUser();// so subsidiary activities are created
@@ -686,6 +695,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider entities_get
+   * @param $Entity
    */
   public function testAcceptsOnlyID_get($Entity) {
     // big random number. fun fact: if you multiply it by pi^e, the result is another random number, but bigger ;)
@@ -720,6 +730,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
    * limitations include the problem with avoiding loops when creating test objects -
    * hence FKs only set by createTestObject when required. e.g parent_id on campaign is not being followed through
    * Currency - only seems to support US
+   * @param $entityName
    */
   public function testByID_get($entityName) {
     if (in_array($entityName, self::toBeSkipped_automock(TRUE))) {
@@ -879,6 +890,8 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
    * limitations include the problem with avoiding loops when creating test objects -
    * hence FKs only set by createTestObject when required. e.g parent_id on campaign is not being followed through
    * Currency - only seems to support US
+   * @param $entityName
+   * @throws \PHPUnit_Framework_IncompleteTestError
    */
   public function testByIDAlias_get($entityName) {
     if (in_array($entityName, self::toBeSkipped_automock(TRUE))) {
@@ -925,6 +938,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider entities_get
+   * @param $Entity
    */
   public function testNonExistantID_get($Entity) {
     // cf testAcceptsOnlyID_get
@@ -952,6 +966,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
   /**
    * @dataProvider toBeSkipped_create
   entities that don't need a create action
+   * @param $Entity
    */
   public function testNotImplemented_create($Entity) {
     $result = civicrm_api($Entity, 'Create', array('version' => 3));
@@ -962,6 +977,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
   /**
    * @dataProvider entities
    * @expectedException PHPUnit_Framework_Error
+   * @param $Entity
    */
   public function testWithoutParam_create($Entity) {
     // should create php complaining that a param is missing
@@ -970,6 +986,8 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider entities_create
+   * @param $Entity
+   * @throws \PHPUnit_Framework_IncompleteTestError
    */
   public function testEmptyParam_create($Entity) {
     $this->markTestIncomplete("fixing this test to test the api functions fails on numberous tests
@@ -988,6 +1006,8 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
    * @dataProvider entities_create
    *
    * Check that create doesn't work with an invalid
+   * @param $Entity
+   * @throws \PHPUnit_Framework_IncompleteTestError
    */
   public function testInvalidID_create($Entity) {
     // turn test off for noew
@@ -1015,6 +1035,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
    * limitations include the problem with avoiding loops when creating test objects -
    * hence FKs only set by createTestObject when required. e.g parent_id on campaign is not being followed through
    * Currency - only seems to support US
+   * @param $entityName
    */
   public function testCreateSingleValueAlter($entityName) {
     if (in_array($entityName, $this->toBeImplemented['create'])) {
@@ -1197,6 +1218,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
   /**
    * @dataProvider toBeSkipped_delete
   entities that don't need a delete action
+   * @param $Entity
    */
   public function testNotImplemented_delete($Entity) {
     $nonExistantID = 151416349;
@@ -1208,6 +1230,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
   /**
    * @dataProvider entities
    * @expectedException PHPUnit_Framework_Error
+   * @param $Entity
    */
   public function testWithoutParam_delete($Entity) {
     // should delete php complaining that a param is missing
@@ -1216,6 +1239,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider entities_delete
+   * @param $Entity
    */
   public function testEmptyParam_delete($Entity) {
     if (in_array($Entity, $this->toBeImplemented['delete'])) {
@@ -1229,6 +1253,8 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
 
   /**
    * @dataProvider entities_delete
+   * @param $Entity
+   * @throws \PHPUnit_Framework_IncompleteTestError
    */
   public function testInvalidID_delete($Entity) {
     // turn test off for now
@@ -1258,6 +1284,8 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
    * limitations include the problem with avoiding loops when creating test objects -
    * hence FKs only set by createTestObject when required. e.g parent_id on campaign is not being followed through
    * Currency - only seems to support US
+   * @param $entityName
+   * @throws \PHPUnit_Framework_IncompleteTestError
    */
   public function testByID_delete($entityName) {
     // turn test off for noew
@@ -1298,6 +1326,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
    * Create two entities and make sure delete action only deletes one!
    *
    * @dataProvider entities_getfields
+   * @param $entity
    */
   public function testGetfieldsHasTitle($entity) {
     $entities = $this->getEntitiesSupportingCustomFields();