Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.

Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.


git-svn-id: https://develop.svn.wordpress.org/trunk@41162 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes
2017-07-27 00:40:27 +00:00
parent 829139ba1a
commit b4d81bd654
135 changed files with 2 additions and 1906 deletions

View File

@@ -21,7 +21,6 @@ class WP_Date_Query {
* See WP_Date_Query::__construct() for information on date query arguments.
*
* @since 3.7.0
* @access public
* @var array
*/
public $queries = array();
@@ -30,7 +29,6 @@ class WP_Date_Query {
* The default relation between top-level queries. Can be either 'AND' or 'OR'.
*
* @since 3.7.0
* @access public
* @var string
*/
public $relation = 'AND';
@@ -39,7 +37,6 @@ class WP_Date_Query {
* The column to query against. Can be changed via the query arguments.
*
* @since 3.7.0
* @access public
* @var string
*/
public $column = 'post_date';
@@ -48,7 +45,6 @@ class WP_Date_Query {
* The value comparison operator. Can be changed via the query arguments.
*
* @since 3.7.0
* @access public
* @var array
*/
public $compare = '=';
@@ -57,7 +53,6 @@ class WP_Date_Query {
* Supported time-related parameter keys.
*
* @since 4.1.0
* @access public
* @var array
*/
public $time_keys = array( 'after', 'before', 'year', 'month', 'monthnum', 'week', 'w', 'dayofyear', 'day', 'dayofweek', 'dayofweek_iso', 'hour', 'minute', 'second' );
@@ -73,7 +68,6 @@ class WP_Date_Query {
* @since 3.7.0
* @since 4.0.0 The $inclusive logic was updated to include all times within the date range.
* @since 4.1.0 Introduced 'dayofweek_iso' time type parameter.
* @access public
*
* @param array $date_query {
* Array of date query clauses.
@@ -191,7 +185,6 @@ class WP_Date_Query {
* `$defaults`.
*
* @since 4.1.0
* @access public
*
* @param array $queries
* @param array $parent_query
@@ -252,7 +245,6 @@ class WP_Date_Query {
* If so, it's first-order.
*
* @since 4.1.0
* @access protected
*
* @param array $query Query clause.
* @return bool True if this is a first-order clause.
@@ -266,7 +258,6 @@ class WP_Date_Query {
* Determines and validates what comparison operator to use.
*
* @since 3.7.0
* @access public
*
* @param array $query A date query or a date subquery.
* @return string The comparison operator.
@@ -286,7 +277,6 @@ class WP_Date_Query {
* This method only generates debug notices for these cases.
*
* @since 4.1.0
* @access public
*
* @param array $date_query The date_query array.
* @return bool True if all values in the query are valid, false if one or more fail.
@@ -482,7 +472,6 @@ class WP_Date_Query {
* and are only sanitized to remove illegal characters.
*
* @since 3.7.0
* @access public
*
* @param string $column The user-supplied column name.
* @return string A validated column name value.
@@ -551,7 +540,6 @@ class WP_Date_Query {
* Generate WHERE clause to be appended to a main query.
*
* @since 3.7.0
* @access public
*
* @return string MySQL WHERE clause.
*/
@@ -578,7 +566,6 @@ class WP_Date_Query {
* out to maintain parity with the other Query classes.
*
* @since 4.1.0
* @access protected
*
* @return array {
* Array containing JOIN and WHERE SQL clauses to append to the main query.
@@ -604,7 +591,6 @@ class WP_Date_Query {
* produce the properly nested SQL.
*
* @since 4.1.0
* @access protected
*
* @param array $query Query to parse.
* @param int $depth Optional. Number of tree levels deep we currently are.
@@ -689,7 +675,6 @@ class WP_Date_Query {
* compatibility while retaining the naming convention across Query classes.
*
* @since 3.7.0
* @access protected
*
* @param array $query Date query arguments.
* @return array {
@@ -707,7 +692,6 @@ class WP_Date_Query {
* Turns a first-order date query into SQL for a WHERE clause.
*
* @since 4.1.0
* @access protected
*
* @param array $query Date query clause.
* @param array $parent_query Parent query of the current date query.
@@ -802,7 +786,6 @@ class WP_Date_Query {
* Builds and validates a value string based on the comparison operator.
*
* @since 3.7.0
* @access public
*
* @param string $compare The compare operator to use
* @param string|array $value The value
@@ -862,7 +845,6 @@ class WP_Date_Query {
* pass a string that will be run through strtotime().
*
* @since 3.7.0
* @access public
*
* @param string|array $datetime An array of parameters or a strotime() string
* @param bool $default_to_max Whether to round up incomplete dates. Supported by values
@@ -950,7 +932,6 @@ class WP_Date_Query {
* in order to be able to accurately compare against.
*
* @since 3.7.0
* @access public
*
* @param string $column The column to query against. Needs to be pre-validated!
* @param string $compare The comparison operator. Needs to be pre-validated!