Merge pull request #1987 from jim-parry/apidocs/errors

Correct API docblock problems for phpdocs

phpdoc.dist.xml

@@ -12,6 +12,10 @@
         <ignore>vendor/*</ignore>
         <ignore>tests/*</ignore>
         <ignore>Kint/*</ignore>
+        <ignore>*.tpl.php</ignore>
+        <ignore>*.js.php</ignore>
+        <ignore>Validation/Views/*</ignore>
+        <ignore>Pager/Views/</ignore>
     </files>
 
     <logging>

system/Autoloader/FileLocator.php

@@ -49,6 +49,8 @@
 class FileLocator
 {
 	/**
+	 * The Autoloader to use.
+	 *
 	 * @var \CodeIgniter\Autoloader\Autoloader
 	 */
 	protected $autoloader;
@@ -261,6 +263,8 @@ protected function ensureExt(string $path, string $ext): string
 	//--------------------------------------------------------------------
 
 	/**
+	 * Return the namespace mappings we know about.
+	 *
 	 * @param string|null $prefix
 	 *
 	 * @return array|string

system/CLI/CLI.php

@@ -41,10 +41,7 @@
 use CodeIgniter\CLI\Exceptions\CLIException;
 
 /**
- * Class CLI
- *
- * Tools to interact with that request since CLI requests are not
- * static like HTTP requests might be.
+ * Set of static methods useful for CLI request handling.
  *
  * Portions of this code were initially from the FuelPHP Framework,
  * version 1.7.x, and used here under the MIT license they were
@@ -61,7 +58,7 @@
  * an argument of "0".
  * These have been flagged to ignore for code coverage purposes.
  *
- * @package CodeIgniter\HTTP
+ * @package CodeIgniter\CLI
  */
 class CLI
 {

system/CLI/CommandRunner.php

@@ -56,6 +56,8 @@ class CommandRunner extends Controller
 	protected $commands = [];
 
 	/**
+	 * Message logger.
+	 *
 	 * @var \CodeIgniter\Log\Logger
 	 */
 	protected $logger;
@@ -85,6 +87,8 @@ public function _remap($method, ...$params)
 	//--------------------------------------------------------------------
 
 	/**
+	 * Default command.
+	 *
 	 * @param array $params
 	 *
 	 * @return mixed

system/Cache/Handlers/FileHandler.php

@@ -63,6 +63,12 @@ class FileHandler implements CacheInterface
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Constructor.
+	 *
+	 * @param  type $config
+	 * @throws type
+	 */
 	public function __construct($config)
 	{
 		$path = ! empty($config->storePath) ? $config->storePath : WRITEPATH . 'cache';

system/Cache/Handlers/MemcachedHandler.php

@@ -74,6 +74,12 @@ class MemcachedHandler implements CacheInterface
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Constructor.
+	 *
+	 * @param  type $config
+	 * @throws type
+	 */
 	public function __construct($config)
 	{
 		$config       = (array)$config;

system/Cache/Handlers/PredisHandler.php

@@ -76,6 +76,12 @@ class PredisHandler implements CacheInterface
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Constructor.
+	 *
+	 * @param  type $config
+	 * @throws type
+	 */
 	public function __construct($config)
 	{
 		$this->prefix = $config->prefix ?: '';

system/Cache/Handlers/RedisHandler.php

@@ -76,6 +76,12 @@ class RedisHandler implements CacheInterface
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Constructor.
+	 *
+	 * @param  type $config
+	 * @throws type
+	 */
 	public function __construct($config)
 	{
 		$config       = (array)$config;

system/Cache/Handlers/WincacheHandler.php

@@ -58,6 +58,12 @@ class WincacheHandler implements CacheInterface
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Constructor.
+	 *
+	 * @param  type $config
+	 * @throws type
+	 */
 	public function __construct($config)
 	{
 		$this->prefix = $config->prefix ?: '';

system/CodeIgniter.php

@@ -161,6 +161,11 @@ class CodeIgniter
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Constructor.
+	 *
+	 * @param type $config
+	 */
 	public function __construct($config)
 	{
 		$this->startTime = microtime(true);

system/Commands/Database/MigrateStatus.php

@@ -96,6 +96,11 @@ class MigrateStatus extends BaseCommand
 		'-g' => 'Set database group',
 	];
 
+	/**
+	 * Namespaces to ignore when looking for migrations.
+	 *
+	 * @var type
+	 */
 	protected $ignoredNamespaces = [
 		'CodeIgniter',
 		'Config',
@@ -118,7 +123,7 @@ public function run(array $params = [])
 			$runner->setGroup($group);
 		}
 
-		// Get all namespaces form  PSR4 paths.
+		// Get all namespaces from  PSR4 paths.
 		$config     = new Autoload();
 		$namespaces = $config->psr4;
 

system/ComposerScripts.php

@@ -53,6 +53,11 @@
  */
 class ComposerScripts
 {
+	/**
+	 * Base path to use.
+	 *
+	 * @var type
+	 */
 	protected static $basePath = 'ThirdParty/';
 
 	/**

system/Config/BaseConfig.php

@@ -57,8 +57,20 @@ class BaseConfig
 	 *
 	 * @var array
 	 */
-	public static $registrars      = [];
+	public static $registrars = [];
+
+	/**
+	 * Has module discovery happened yet?
+	 *
+	 * @var boolean
+	 */
 	protected static $didDiscovery = false;
+
+	/**
+	 * The modules configuration.
+	 *
+	 * @var type
+	 */
 	protected static $moduleConfig;
 
 	/**

system/Config/ForeignCharacters.php

@@ -38,15 +38,13 @@
 
 namespace CodeIgniter\Config;
 
+/**
+ * Describes foreign characters for transliteration with the text helper.
+ */
 class ForeignCharacters
 {
-	/*
-	  | -------------------------------------------------------------------
-	  | Foreign Characters
-	  | -------------------------------------------------------------------
-	  | This file contains an array of foreign characters for transliteration
-	  | conversion used by the Text helper
-	  |
+	/**
+	 * Without further ado, the list of foreign characters.
 	 */
 
 	public $characterList = [

system/Config/Services.php

@@ -384,6 +384,8 @@ public static function logger(bool $getShared = true)
 	//--------------------------------------------------------------------
 
 	/**
+	 * Return the appropriate igration runner.
+	 *
 	 * @param \CodeIgniter\Config\BaseConfig            $config
 	 * @param \CodeIgniter\Database\ConnectionInterface $db
 	 * @param boolean                                   $getShared
@@ -432,6 +434,8 @@ public static function negotiator(RequestInterface $request = null, bool $getSha
 	//--------------------------------------------------------------------
 
 	/**
+	 * Return the appropriate pagination handler.
+	 *
 	 * @param mixed                               $config
 	 * @param \CodeIgniter\View\RendererInterface $view
 	 * @param boolean                             $getShared
@@ -684,6 +688,8 @@ public static function security(App $config = null, bool $getShared = true)
 	//--------------------------------------------------------------------
 
 	/**
+	 * Return the session manager.
+	 *
 	 * @param \Config\App $config
 	 * @param boolean     $getShared
 	 *
@@ -761,6 +767,8 @@ public static function timer(bool $getShared = true)
 	//--------------------------------------------------------------------
 
 	/**
+	 * Return the debug toolbar.
+	 *
 	 * @param \Config\Toolbar $config
 	 * @param boolean         $getShared
 	 *

system/Config/View.php

@@ -44,6 +44,11 @@
 class View extends BaseConfig
 {
 
+	/**
+	 * Built-in View filters.
+	 *
+	 * @var type
+	 */
 	protected $coreFilters = [
 		'abs'            => '\abs',
 		'capitalize'     => '\CodeIgniter\View\Filters::capitalize',
@@ -67,6 +72,12 @@ class View extends BaseConfig
 		'title'          => '\CodeIgniter\View\Filters::title',
 		'upper'          => '\strtoupper',
 	];
+
+	/**
+	 * Built-in View plugins.
+	 *
+	 * @var type
+	 */
 	protected $corePlugins = [
 		'current_url'       => '\CodeIgniter\View\Plugins::currentURL',
 		'previous_url'      => '\CodeIgniter\View\Plugins::previousURL',
@@ -78,6 +89,12 @@ class View extends BaseConfig
 		'siteURL'           => '\CodeIgniter\View\Plugins::siteURL',
 	];
 
+	/**
+	 * Constructor.
+	 *
+	 * Merge the built-in and developer-configured filters and plugins,
+	 * with preference to the developer ones.
+	 */
 	public function __construct()
 	{
 		$this->filters = array_merge($this->coreFilters, $this->filters);

system/Database/BaseConnection.php

@@ -1808,6 +1808,8 @@ abstract protected function _foreignKeyData(string $table): array;
 	//--------------------------------------------------------------------
 
 	/**
+	 * Accessor for properties if they exist.
+	 *
 	 * @param string $key
 	 *
 	 * @return mixed

system/Database/BasePreparedQuery.php

@@ -84,6 +84,11 @@ abstract class BasePreparedQuery implements PreparedQueryInterface
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Constructor.
+	 *
+	 * @param \CodeIgniter\Database\ConnectionInterface $db
+	 */
 	public function __construct(ConnectionInterface $db)
 	{
 		$this->db = &$db;

system/Database/MySQLi/PreparedQuery.php

@@ -41,6 +41,9 @@
 use CodeIgniter\Database\PreparedQueryInterface;
 use CodeIgniter\Database\BasePreparedQuery;
 
+/**
+ * Prepared query for MySQLi
+ */
 class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface
 {
 

system/Database/Postgre/PreparedQuery.php

@@ -41,6 +41,9 @@
 use CodeIgniter\Database\PreparedQueryInterface;
 use CodeIgniter\Database\BasePreparedQuery;
 
+/**
+ * Prepared query for Postgre
+ */
 class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface
 {
 

system/Database/SQLite3/Builder.php

@@ -76,9 +76,9 @@ class Builder extends BaseBuilder
 	 *
 	 * Generates a platform-specific replace string from the supplied data
 	 *
-	 * @param string    the table name
-	 * @param array     the insert keys
-	 * @param array     the insert values
+	 * @param string $table  the table name
+	 * @param array  $keys   the insert keys
+	 * @param array  $values the insert values
 	 *
 	 * @return string
 	 */

system/Database/SQLite3/PreparedQuery.php

@@ -41,6 +41,10 @@
 use CodeIgniter\Database\PreparedQueryInterface;
 use CodeIgniter\Database\BasePreparedQuery;
 
+/**
+ * Prepared query for SQLite3
+ */
+
 class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface
 {
 

system/Database/SQLite3/Table.php

@@ -88,11 +88,15 @@ class Table
 	protected $prefixedTableName;
 
 	/**
+	 * Database connection.
+	 *
 	 * @var Connection
 	 */
 	protected $db;
 
 	/**
+	 * Handle to our forge.
+	 *
 	 * @var Forge
 	 */
 	protected $forge;
@@ -101,6 +105,7 @@ class Table
 	 * Table constructor.
 	 *
 	 * @param Connection $db
+	 * @param Forge      $forge
 	 */
 	public function __construct(Connection $db, Forge $forge)
 	{