Skip to content

Commit 47c68d4

Browse files
committed
Fourth set of docblock corrections.
1 parent 0cbe0f6 commit 47c68d4

File tree

7 files changed

+40
-4
lines changed

7 files changed

+40
-4
lines changed

system/CodeIgniter.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,11 @@ class CodeIgniter
161161

162162
//--------------------------------------------------------------------
163163

164+
/**
165+
* Constructor.
166+
*
167+
* @param type $config
168+
*/
164169
public function __construct($config)
165170
{
166171
$this->startTime = microtime(true);

system/Commands/Database/MigrateStatus.php

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,11 @@ class MigrateStatus extends BaseCommand
9696
'-g' => 'Set database group',
9797
];
9898

99+
/**
100+
* Namespaces to ignore when looking for migrations.
101+
*
102+
* @var type
103+
*/
99104
protected $ignoredNamespaces = [
100105
'CodeIgniter',
101106
'Config',
@@ -118,7 +123,7 @@ public function run(array $params = [])
118123
$runner->setGroup($group);
119124
}
120125

121-
// Get all namespaces form PSR4 paths.
126+
// Get all namespaces from PSR4 paths.
122127
$config = new Autoload();
123128
$namespaces = $config->psr4;
124129

system/ComposerScripts.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,11 @@
5353
*/
5454
class ComposerScripts
5555
{
56+
/**
57+
* Base path to use.
58+
*
59+
* @var type
60+
*/
5661
protected static $basePath = 'ThirdParty/';
5762

5863
/**

system/HTTP/DownloadResponse.php

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@
4242
use CodeIgniter\Files\File;
4343
use Config\Mimes;
4444

45+
/**
46+
* HTTP response when a download is requested.
47+
*/
4548
class DownloadResponse extends Message implements ResponseInterface
4649
{
4750
/**
@@ -93,6 +96,12 @@ class DownloadResponse extends Message implements ResponseInterface
9396
*/
9497
private $pretend = false;
9598

99+
/**
100+
* Constructor.
101+
*
102+
* @param string $filename
103+
* @param boolean $setMime
104+
*/
96105
public function __construct(string $filename, bool $setMime)
97106
{
98107
$this->filename = $filename;
@@ -348,6 +357,12 @@ public function setLastModified($date)
348357
// Output Methods
349358
//--------------------------------------------------------------------
350359

360+
/**
361+
* For unit testing, don't actually send headers.
362+
*
363+
* @param boolean $pretend
364+
* @return $this
365+
*/
351366
public function pretend(bool $pretend = true)
352367
{
353368
$this->pretend = $pretend;

system/HTTP/IncomingRequest.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,8 @@ class IncomingRequest extends Request
127127
protected $validLocales = [];
128128

129129
/**
130+
* Configuration settings.
131+
*
130132
* @var \Config\App
131133
*/
132134
public $config;
@@ -139,6 +141,8 @@ class IncomingRequest extends Request
139141
protected $oldInput = [];
140142

141143
/**
144+
* The user agent this request is from.
145+
*
142146
* @var \CodeIgniter\HTTP\UserAgent
143147
*/
144148
protected $userAgent;
@@ -150,7 +154,7 @@ class IncomingRequest extends Request
150154
*
151155
* @param object $config
152156
* @param \CodeIgniter\HTTP\URI $uri
153-
* @param string|null $body
157+
* @param string|null $body
154158
* @param \CodeIgniter\HTTP\UserAgent $userAgent
155159
*/
156160
public function __construct($config, URI $uri = null, $body = 'php://input', UserAgent $userAgent)

system/Helpers/security_helper.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@
5151
if (! function_exists('sanitize_filename'))
5252
{
5353
/**
54+
* Sanitize a filename to use in a URI.
55+
*
5456
* @param string $filename
5557
*
5658
* @return string
@@ -88,7 +90,7 @@ function strip_image_tags(string $str): string
8890
/**
8991
* Convert PHP tags to entities
9092
*
91-
* @param string
93+
* @param string $str
9294
* @return string
9395
*/
9496
function encode_php_tags(string $str): string

system/Helpers/url_helper.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,7 @@ function auto_link(string $str, string $type = 'both', bool $popup = false): str
529529
* Formerly used URI, but that does not play nicely with URIs missing
530530
* the scheme.
531531
*
532-
* @param string the URL
532+
* @param string $str the URL
533533
* @return string
534534
*/
535535
function prep_url(string $str = ''): string

0 commit comments

Comments
 (0)