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

Correct API docblock problems for phpdocs

Author: jim-parry

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);