From 048555566c0b1535f8e8cc802b0991399503319c Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:38 -0800 Subject: [PATCH] INFRA-132 - Civi - Convert single-line @param to multi-line --- Civi/CCase/Analyzer.php | 9 ++++++--- Civi/CCase/SequenceListener.php | 6 ++++-- Civi/CiUtil/CSVParser.php | 3 ++- Civi/CiUtil/Command/AntagonistCommand.php | 6 ++++-- Civi/CiUtil/JenkinsParser.php | 3 ++- Civi/CiUtil/PHPUnitParser.php | 6 ++++-- Civi/Core/Container.php | 3 ++- Civi/Core/Transaction/Frame.php | 6 ++++-- Civi/Core/Transaction/Manager.php | 6 ++++-- 9 files changed, 32 insertions(+), 16 deletions(-) diff --git a/Civi/CCase/Analyzer.php b/Civi/CCase/Analyzer.php index a2321b99fb..633688a225 100644 --- a/Civi/CCase/Analyzer.php +++ b/Civi/CCase/Analyzer.php @@ -65,8 +65,10 @@ class Analyzer { /** * Determine if case includes an activity of given type/status * - * @param string $type eg "Phone Call", "Interview Prospect", "Background Check" - * @param string $status eg "Scheduled", "Completed" + * @param string $type + * Eg "Phone Call", "Interview Prospect", "Background Check". + * @param string $status + * Eg "Scheduled", "Completed". * @return bool */ public function hasActivity($type, $status = NULL) { @@ -180,7 +182,8 @@ class Analyzer { /** * Get a list of all activities in the case (indexed by some property/properties) * - * @param array $keys list of properties by which to index activities + * @param array $keys + * List of properties by which to index activities. * @return array list of activity records (api/v3 format), indexed by $keys */ public function getActivityIndex($keys) { diff --git a/Civi/CCase/SequenceListener.php b/Civi/CCase/SequenceListener.php index b885f406dc..7b40e7fbc6 100644 --- a/Civi/CCase/SequenceListener.php +++ b/Civi/CCase/SequenceListener.php @@ -14,7 +14,8 @@ class SequenceListener implements CaseChangeListener { private static $singleton; /** - * @param bool $reset whether to forcibly rebuild the entire container + * @param bool $reset + * Whether to forcibly rebuild the entire container. * @return \Symfony\Component\DependencyInjection\TaggedContainerInterface */ public static function singleton($reset = FALSE) { @@ -87,7 +88,8 @@ class SequenceListener implements CaseChangeListener { } /** - * @param Analyzer $analyzer the case being analyzed -- to which we want to add an activity + * @param Analyzer $analyzer + * The case being analyzed -- to which we want to add an activity. * @param \SimpleXMLElement $actXML the tag which describes the new activity */ public function createActivity(Analyzer $analyzer, \SimpleXMLElement $actXML) { diff --git a/Civi/CiUtil/CSVParser.php b/Civi/CiUtil/CSVParser.php index 46712d8d4e..e09f799295 100644 --- a/Civi/CiUtil/CSVParser.php +++ b/Civi/CiUtil/CSVParser.php @@ -7,7 +7,8 @@ namespace Civi\CiUtil; class CSVParser { /** - * @param string $csvContent content; each row in the row csv should start with two cells: + * @param string $csvContent + * Content; each row in the row csv should start with two cells:. * - cell 0: the test name * - cell 1: the test status * @return array (string $testName => string $status) diff --git a/Civi/CiUtil/Command/AntagonistCommand.php b/Civi/CiUtil/Command/AntagonistCommand.php index 3c7c946897..5d6e7bbe54 100644 --- a/Civi/CiUtil/Command/AntagonistCommand.php +++ b/Civi/CiUtil/Command/AntagonistCommand.php @@ -26,8 +26,10 @@ class AntagonistCommand { } /** - * @param string $target e.g. "MyTest::testFoo" - * @param array $candidateTests list of strings (e.g. "MyTest::testFoo") + * @param string $target + * E.g. "MyTest::testFoo". + * @param array $candidateTests + * List of strings (e.g. "MyTest::testFoo"). * @return array|null array contains keys: * - antagonist: array * - file: string diff --git a/Civi/CiUtil/JenkinsParser.php b/Civi/CiUtil/JenkinsParser.php index 5725f0b2e2..c99c571091 100644 --- a/Civi/CiUtil/JenkinsParser.php +++ b/Civi/CiUtil/JenkinsParser.php @@ -6,7 +6,8 @@ namespace Civi\CiUtil; */ class JenkinsParser { /** - * @param string $content xml data + * @param string $content + * Xml data. * @return array (string $testName => string $status) */ public static function parseXmlResults($content) { diff --git a/Civi/CiUtil/PHPUnitParser.php b/Civi/CiUtil/PHPUnitParser.php index dacb7457e7..835954623b 100644 --- a/Civi/CiUtil/PHPUnitParser.php +++ b/Civi/CiUtil/PHPUnitParser.php @@ -6,7 +6,8 @@ namespace Civi\CiUtil; */ class PHPUnitParser { /** - * @param string $content phpunit streaming JSON + * @param string $content + * Phpunit streaming JSON. * @return array(string "$class::$func" => $status) */ protected static function parseJsonStream($content) { @@ -17,7 +18,8 @@ class PHPUnitParser { } /** - * @param string $content json stream + * @param string $content + * Json stream. * @return array (string $testName => string $status) */ public static function parseJsonResults($content) { diff --git a/Civi/Core/Container.php b/Civi/Core/Container.php index 4ee59208a9..5d951e19d0 100644 --- a/Civi/Core/Container.php +++ b/Civi/Core/Container.php @@ -27,7 +27,8 @@ class Container { private static $singleton; /** - * @param bool $reset whether to forcibly rebuild the entire container + * @param bool $reset + * Whether to forcibly rebuild the entire container. * @return \Symfony\Component\DependencyInjection\TaggedContainerInterface */ public static function singleton($reset = FALSE) { diff --git a/Civi/Core/Transaction/Frame.php b/Civi/Core/Transaction/Frame.php index e060157ad6..153ab5e683 100644 --- a/Civi/Core/Transaction/Frame.php +++ b/Civi/Core/Transaction/Frame.php @@ -156,8 +156,10 @@ class Frame { * * Pre-condition: isActive() * - * @param int $phase A constant; one of: self::PHASE_{PRE,POST}_{COMMIT,ROLLBACK} - * @param mixed $callback A PHP callback + * @param int $phase + * A constant; one of: self::PHASE_{PRE,POST}_{COMMIT,ROLLBACK}. + * @param mixed $callback + * A PHP callback. * @param array|NULL $params Optional values to pass to callback. * See php manual call_user_func_array for details. */ diff --git a/Civi/Core/Transaction/Manager.php b/Civi/Core/Transaction/Manager.php index 3e24de811d..4efb1c0a54 100644 --- a/Civi/Core/Transaction/Manager.php +++ b/Civi/Core/Transaction/Manager.php @@ -63,7 +63,8 @@ class Manager { } /** - * @param CRM_Core_DAO $dao handle for the DB connection that will execute transaction statements + * @param CRM_Core_DAO $dao + * Handle for the DB connection that will execute transaction statements. * (all we really care about is the query() function) */ public function __construct($dao) { @@ -73,7 +74,8 @@ class Manager { /** * Increment the transaction count / add a new transaction level * - * @param bool $nest Determines what to do if there's currently an active transaction: + * @param bool $nest + * Determines what to do if there's currently an active transaction:. * - If true, then make a new nested transaction ("SAVEPOINT") * - If false, then attach to the existing transaction */ -- 2.25.1