Fifth batch of docblock corrections

jim-parry · jim-parry · commit 48e83868de84 · 2019-05-05T23:53:08.000-07:00
diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml
@@ -15,6 +15,7 @@
         <ignore>*.tpl.php</ignore>
         <ignore>*.js.php</ignore>
         <ignore>Validation/Views/*</ignore>
+        <ignore>Pager/Views/</ignore>
     </files>
 
     <logging>
diff --git a/system/Entity.php b/system/Entity.php
@@ -47,8 +47,7 @@
  */
 class Entity
 {
-	protected $_options = [
-		/*
+		/**
 		 * Maps names used in sets and gets against unique
 		 * names within the class, allowing independence from
 		 * database column names.
@@ -58,9 +57,10 @@ class Entity
 		 *      'db_name' => 'class_name'
 		 *  ];
 		 */
+	protected $_options = [
 		'datamap' => [],
 
-		/*
+		/**
 		 * Define properties that are automatically converted to Time instances.
 		 */
 		'dates'   => [
@@ -69,7 +69,7 @@ class Entity
 			'deleted_at',
 		],
 
-		/*
+		/**
 		 * Array of field names and the type of value to cast them as
 		 * when they are accessed.
 		 */
diff --git a/system/Helpers/array_helper.php b/system/Helpers/array_helper.php
@@ -38,11 +38,7 @@
 /**
  * CodeIgniter Array Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/cookie_helper.html
+ * @package CodeIgniter
  */
 
 if (! function_exists('dot_array_search'))
diff --git a/system/Helpers/cookie_helper.php b/system/Helpers/cookie_helper.php
@@ -40,11 +40,7 @@
 /**
  * CodeIgniter Cookie Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/cookie_helper.html
+ * @package CodeIgniter
  */
 if (! function_exists('set_cookie'))
 {
diff --git a/system/Helpers/date_helper.php b/system/Helpers/date_helper.php
@@ -38,11 +38,7 @@
 /**
  * CodeIgniter Date Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/date_helper.html
+ * @package CodeIgniter
  */
 
 if (! function_exists('now'))
diff --git a/system/Helpers/filesystem_helper.php b/system/Helpers/filesystem_helper.php
@@ -40,11 +40,7 @@
 /**
  * CodeIgniter File System Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/directory_helper.html
+ * @package CodeIgniter
  */
 // ------------------------------------------------------------------------
 
@@ -160,10 +156,10 @@ function write_file(string $path, string $data, string $mode = 'wb'): bool
 	 * If the second parameter is set to true, any directories contained
 	 * within the supplied base directory will be nuked as well.
 	 *
-	 * @param string  $path   File path
+	 * @param string  $path    File path
 	 * @param boolean $del_dir Whether to delete any directories found in the path
-	 * @param boolean $htdocs Whether to skip deleting .htaccess and index page files
-	 * @param integer $_level Current directory depth level (default: 0; internal use only)
+	 * @param boolean $htdocs  Whether to skip deleting .htaccess and index page files
+	 * @param integer $_level  Current directory depth level (default: 0; internal use only)
 	 *
 	 * @return boolean
 	 */
diff --git a/system/Helpers/form_helper.php b/system/Helpers/form_helper.php
@@ -41,11 +41,7 @@
 /**
  * CodeIgniter Form Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/form_helper.html
+ * @package CodeIgniter
  */
 
 //--------------------------------------------------------------------
diff --git a/system/Helpers/html_helper.php b/system/Helpers/html_helper.php
@@ -40,11 +40,7 @@
 /**
  * CodeIgniter HTML Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/html_helper.html
+ * @package CodeIgniter
  */
 if (! function_exists('ul'))
 {
diff --git a/system/Helpers/inflector_helper.php b/system/Helpers/inflector_helper.php
@@ -40,11 +40,7 @@
 /**
  * CodeIgniter Inflector Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/inflector_helper.html
+ * @package CodeIgniter
  */
 if (! function_exists('singular'))
 {
diff --git a/system/Helpers/number_helper.php b/system/Helpers/number_helper.php
@@ -39,11 +39,7 @@
 /**
  * CodeIgniter Number Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/number_helper.html
+ * @package CodeIgniter
  */
 
 if (! function_exists('number_to_size'))
diff --git a/system/Helpers/security_helper.php b/system/Helpers/security_helper.php
@@ -41,11 +41,7 @@
 /**
  * CodeIgniter Security Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/security_helper.html
+ * @package CodeIgniter
  */
 
 if (! function_exists('sanitize_filename'))
diff --git a/system/Helpers/text_helper.php b/system/Helpers/text_helper.php
@@ -40,11 +40,7 @@
 /**
  * CodeIgniter Text Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/text_helper.html
+ * @package CodeIgniter
  */
 //--------------------------------------------------------------------
 
diff --git a/system/Helpers/url_helper.php b/system/Helpers/url_helper.php
@@ -38,11 +38,7 @@
 /**
  * CodeIgniter URL Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/url_helper.html
+ * @package CodeIgniter
  */
 
 if (! function_exists('site_url'))
diff --git a/system/Helpers/xml_helper.php b/system/Helpers/xml_helper.php
@@ -38,11 +38,7 @@
 /**
  * CodeIgniter XML Helpers
  *
- * @package    CodeIgniter
- * @subpackage Helpers
- * @category   Helpers
- * @author     CodeIgniter Dev Team
- * @link       https://codeigniter.com/user_guide/helpers/xml_helper.html
+ * @package CodeIgniter
  */
 
 if (! function_exists('xml_convert'))
diff --git a/system/Images/Handlers/BaseHandler.php b/system/Images/Handlers/BaseHandler.php
@@ -49,6 +49,8 @@ abstract class BaseHandler implements ImageHandlerInterface
 {
 
 	/**
+	 * Configuration settings.
+	 *
 	 * @var \Config\Images
 	 */
 	protected $config;
diff --git a/system/Model.php b/system/Model.php
@@ -246,23 +246,57 @@ class Model
 	 */
 	protected $validation;
 
-	/**
+	/*
 	 * Callbacks. Each array should contain the method
 	 * names (within the model) that should be called
 	 * when those events are triggered. With the exception
 	 * of 'afterFind', all methods are passed the same
 	 * items that are given to the update/insert method.
 	 * 'afterFind' will also include the results that were found.
+	 */
+
+	/**
+	 * Callbacks for beforeInsert
 	 *
-	 * @var array
+	 * @var type
 	 */
 	protected $beforeInsert = [];
-	protected $afterInsert  = [];
+	/**
+	 * Callbacks for afterInsert
+	 *
+	 * @var type
+	 */
+	protected $afterInsert = [];
+	/**
+	 * Callbacks for beforeUpdate
+	 *
+	 * @var type
+	 */
 	protected $beforeUpdate = [];
-	protected $afterUpdate  = [];
-	protected $afterFind    = [];
+	/**
+	 * Callbacks for afterUpdate
+	 *
+	 * @var type
+	 */
+	protected $afterUpdate = [];
+	/**
+	 * Callbacks for afterFind
+	 *
+	 * @var type
+	 */
+	protected $afterFind = [];
+	/**
+	 * Callbacks for beforeDelete
+	 *
+	 * @var type
+	 */
 	protected $beforeDelete = [];
-	protected $afterDelete  = [];
+	/**
+	 * Callbacks for afterDelete
+	 *
+	 * @var type
+	 */
+	protected $afterDelete = [];
 
 	/**
 	 * Holds information passed in via 'set'
diff --git a/system/Typography/Typography.php b/system/Typography/Typography.php
@@ -386,7 +386,7 @@ protected function protectCharacters(array $match): string
 	/**
 	 * Convert newlines to HTML line breaks except within PRE tags
 	 *
-	 * @param  string
+	 * @param  string $str
 	 * @return string
 	 */
 	public function nl2brExceptPre(string $str): string

Original file line number	Diff line number	Diff line change
`@@ -40,11 +40,7 @@`
`40`	`40`	`/**`
`41`	`41`	`* CodeIgniter Cookie Helpers`
`42`	`42`	`*`
`43`		`- * @package CodeIgniter`
`44`		`- * @subpackage Helpers`
`45`		`- * @category Helpers`
`46`		`- * @author CodeIgniter Dev Team`
`47`		`- * @link https://codeigniter.com/user_guide/helpers/cookie_helper.html`
	`43`	`+ * @package CodeIgniter`
`48`	`44`	`*/`
`49`	`45`	`if (! function_exists('set_cookie'))`
`50`	`46`	`{`