Completed
Pull Request — 3 (#8026)
by Damian
08:19
created
dev/BulkLoader.php 1 patch
Doc Comments   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -211,7 +211,7 @@  discard block
 block discarded – undo
211 211
 	 *
212 212
 	 * @todo Mix in custom column mappings
213 213
 	 *
214
-	 * @return array
214
+	 * @return string
215 215
 	 **/
216 216
 	public function getImportSpec() {
217 217
 		$spec = array();
@@ -237,7 +237,7 @@  discard block
 block discarded – undo
237 237
 	 * so this is mainly a customization method.
238 238
 	 *
239 239
 	 * @param mixed $val
240
-	 * @param string $field Name of the field as specified in the array-values for {@link self::$columnMap}.
240
+	 * @param string $fieldName Name of the field as specified in the array-values for {@link self::$columnMap}.
241 241
 	 * @return boolean
242 242
 	 */
243 243
 	protected function isNullValue($val, $fieldName = null) {
@@ -361,7 +361,7 @@  discard block
 block discarded – undo
361 361
 
362 362
 	/**
363 363
 	 * @param $obj DataObject
364
-	 * @param $message string
364
+	 * @param string $message string
365 365
 	 */
366 366
 	public function addCreated($obj, $message = null) {
367 367
 		$this->created[] = $this->lastChange = array(
@@ -374,7 +374,7 @@  discard block
 block discarded – undo
374 374
 
375 375
 	/**
376 376
 	 * @param $obj DataObject
377
-	 * @param $message string
377
+	 * @param string $message string
378 378
 	 */
379 379
 	public function addUpdated($obj, $message = null) {
380 380
 		$this->updated[] = $this->lastChange = array(
@@ -386,8 +386,8 @@  discard block
 block discarded – undo
386 386
 	}
387 387
 
388 388
 	/**
389
-	 * @param $obj DataObject
390
-	 * @param $message string
389
+	 * @param DataObject|null $obj DataObject
390
+	 * @param string $message string
391 391
 	 */
392 392
 	public function addDeleted($obj, $message = null) {
393 393
 		$data = $obj->toMap();
Please login to merge, or discard this patch.
control/HTTPRequest.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -385,9 +385,9 @@  discard block
 block discarded – undo
385 385
 	 * it's only advisable to send small files through this method.
386 386
 	 *
387 387
 	 * @static
388
-	 * @param $fileData
388
+	 * @param string $fileData
389 389
 	 * @param $fileName
390
-	 * @param null $mimeType
390
+	 * @param string $mimeType
391 391
 	 * @return SS_HTTPResponse
392 392
 	 */
393 393
 	public static function send_file($fileData, $fileName, $mimeType = null) {
@@ -605,7 +605,7 @@  discard block
 block discarded – undo
605 605
 	 * This is used by the request handler to prevent infinite parsing loops.
606 606
 	 *
607 607
 	 * @param $pattern
608
-	 * @return bool
608
+	 * @return boolean|null
609 609
 	 */
610 610
 	public function isEmptyPattern($pattern) {
611 611
 		if(preg_match('/^([A-Za-z]+) +(.*)$/', $pattern, $matches)) {
Please login to merge, or discard this patch.
thirdparty/Zend/Cache/Backend/BlackHole.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -56,7 +56,7 @@  discard block
 block discarded – undo
56 56
      * Test if a cache is available or not (for the given id)
57 57
      *
58 58
      * @param  string $id cache id
59
-     * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record
59
+     * @return boolean false (a cache is not available) or "last modified" timestamp (int) of the available cache record
60 60
      */
61 61
     public function test($id)
62 62
     {
@@ -192,7 +192,7 @@  discard block
 block discarded – undo
192 192
      * - mtime : timestamp of last modification time
193 193
      *
194 194
      * @param  string $id cache id
195
-     * @return array array of metadatas (false if the cache id is not found)
195
+     * @return boolean array of metadatas (false if the cache id is not found)
196 196
      */
197 197
     public function getMetadatas($id)
198 198
     {
Please login to merge, or discard this patch.
thirdparty/Zend/Loader/Autoloader/Resource.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -136,7 +136,7 @@
 block discarded – undo
136 136
      * Helper method to calculate the correct class path
137 137
      *
138 138
      * @param string $class
139
-     * @return False if not matched other wise the correct path
139
+     * @return false|string if not matched other wise the correct path
140 140
      */
141 141
     public function getClassPath($class)
142 142
     {
Please login to merge, or discard this patch.
thirdparty/Zend/Loader/PluginLoader.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -283,7 +283,7 @@
 block discarded – undo
283 283
      * Whether or not a Plugin by a specific name is loaded
284 284
      *
285 285
      * @param string $name
286
-     * @return Zend_Loader_PluginLoader
286
+     * @return boolean
287 287
      */
288 288
     public function isLoaded($name)
289 289
     {
Please login to merge, or discard this patch.
admin/code/LeftAndMain.php 1 patch
Doc Comments   +6 added lines, -1 removed lines patch added patch discarded remove patch
@@ -555,6 +555,7 @@  discard block
 block discarded – undo
555 555
 	 * Returns the menu title for the given LeftAndMain subclass.
556 556
 	 * Implemented static so that we can get this value without instantiating an object.
557 557
 	 * Menu title is *not* internationalised.
558
+	 * @return string
558 559
 	 */
559 560
 	public static function menu_title_for_class($class) {
560 561
 		$title = Config::inst()->get($class, 'menu_title', Config::FIRST_SET);
@@ -720,6 +721,7 @@  discard block
 block discarded – undo
720 721
 	 * Return a list of appropriate templates for this class, with the given suffix using
721 722
 	 * {@link SSViewer::get_templates_by_class()}
722 723
 	 *
724
+	 * @param string $suffix
723 725
 	 * @return array
724 726
 	 */
725 727
 	public function getTemplatesWithSuffix($suffix) {
@@ -1740,7 +1742,7 @@  discard block
 block discarded – undo
1740 1742
 	}
1741 1743
 
1742 1744
 	/**
1743
-	 * @return String
1745
+	 * @return DBField
1744 1746
 	 */
1745 1747
 	public function Locale() {
1746 1748
 		return DBField::create_field('DBLocale', i18n::get_locale());
@@ -1906,6 +1908,9 @@  discard block
 block discarded – undo
1906 1908
 		return (parent::isFinished() || $this->isFinished);
1907 1909
 	}
1908 1910
 
1911
+	/**
1912
+	 * @param boolean $bool
1913
+	 */
1909 1914
 	public function setIsFinished($bool) {
1910 1915
 		$this->isFinished = $bool;
1911 1916
 	}
Please login to merge, or discard this patch.
api/RSSFeed.php 1 patch
Doc Comments   +2 added lines patch added patch discarded remove patch
@@ -219,6 +219,7 @@  discard block
 block discarded – undo
219 219
 	 * via the standard template inclusion process.
220 220
 	 *
221 221
 	 * @param string
222
+	 * @param string $template
222 223
 	 */
223 224
 	public function setTemplate($template) {
224 225
 		$this->template = $template;
@@ -315,6 +316,7 @@  discard block
 block discarded – undo
315 316
 	/**
316 317
 	 * Return the named field as an obj() call from $this->failover.
317 318
 	 * Default to the given class if there's no casting information.
319
+	 * @param string $fieldName
318 320
 	 */
319 321
 	public function rssField($fieldName, $defaultClass = 'Varchar') {
320 322
 		if($fieldName) {
Please login to merge, or discard this patch.
dev/DebugView.php 1 patch
Doc Comments   +1 added lines patch added patch discarded remove patch
@@ -126,6 +126,7 @@
 block discarded – undo
126 126
 	 *
127 127
 	 * @param string $title
128 128
 	 * @param string $title
129
+	 * @param string|false $subtitle
129 130
 	 */
130 131
 	public function writeInfo($title, $subtitle, $description=false) {
131 132
 		echo '<div class="info">';
Please login to merge, or discard this patch.
dev/SapphireTest.php 1 patch
Doc Comments   +11 added lines, -9 removed lines patch added patch discarded remove patch
@@ -142,6 +142,7 @@  discard block
 block discarded – undo
142 142
 
143 143
 	/**
144 144
 	 * Set the manifest to be used to look up test classes by helper functions
145
+	 * @param SS_ClassManifest $manifest
145 146
 	 */
146 147
 	public static function set_test_class_manifest($manifest) {
147 148
 		self::$test_class_manifest = $manifest;
@@ -394,7 +395,7 @@  discard block
 block discarded – undo
394 395
 	/**
395 396
 	 * Get the ID of an object from the fixture.
396 397
 	 *
397
-	 * @param $className The data class, as specified in your fixture file.  Parent classes won't work
398
+	 * @param string $className The data class, as specified in your fixture file.  Parent classes won't work
398 399
 	 * @param $identifier The identifier string, as provided in your fixture file
399 400
 	 * @return int
400 401
 	 */
@@ -417,7 +418,7 @@  discard block
 block discarded – undo
417 418
 	 * Will collate all IDs form all fixtures if multiple fixtures are provided.
418 419
 	 *
419 420
 	 * @param string $className
420
-	 * @return array A map of fixture-identifier => object-id
421
+	 * @return A A map of fixture-identifier => object-id
421 422
 	 */
422 423
 	protected function allFixtureIDs($className) {
423 424
 		return $this->getFixtureFactory()->getIds($className);
@@ -574,10 +575,10 @@  discard block
 block discarded – undo
574 575
 	/**
575 576
 	 * Assert that the matching email was sent since the last call to clearEmails()
576 577
 	 * All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
577
-	 * @param $to
578
+	 * @param string $to
578 579
 	 * @param $from
579
-	 * @param $subject
580
-	 * @param $content
580
+	 * @param string $subject
581
+	 * @param string $content
581 582
 	 * @return array Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles',
582 583
 	 *               'customHeaders', 'htmlContent', inlineImages'
583 584
 	 */
@@ -738,7 +739,7 @@  discard block
 block discarded – undo
738 739
 	 * @param string $expectedSQL
739 740
 	 * @param string $actualSQL
740 741
 	 * @param string $message
741
-	 * @param float $delta
742
+	 * @param integer $delta
742 743
 	 * @param integer $maxDepth
743 744
 	 * @param boolean $canonicalize
744 745
 	 * @param boolean $ignoreCase
@@ -937,6 +938,7 @@  discard block
 block discarded – undo
937 938
 	/**
938 939
 	 * Create a member and group with the given permission code, and log in with it.
939 940
 	 * Returns the member ID.
941
+	 * @return integer
940 942
 	 */
941 943
 	public function logInWithPermission($permCode = "ADMIN") {
942 944
 		if(!isset($this->cache_generatedMembers[$permCode])) {
@@ -976,9 +978,9 @@  discard block
 block discarded – undo
976 978
 	/**
977 979
 	 * Test against a theme.
978 980
 	 *
979
-	 * @param $themeBaseDir string - themes directory
980
-	 * @param $theme string - theme name
981
-	 * @param $callback Closure
981
+	 * @param string $themeBaseDir string - themes directory
982
+	 * @param string $theme string - theme name
983
+	 * @param Closure $callback Closure
982 984
 	 */
983 985
 	protected function useTestTheme($themeBaseDir, $theme, $callback) {
984 986
 		Config::nest();
Please login to merge, or discard this patch.