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
-20
View File
@@ -26,7 +26,6 @@ class WP_Meta_Query {
* See WP_Meta_Query::__construct() for information on meta query arguments.
*
* @since 3.2.0
* @access public
* @var array
*/
public $queries = array();
@@ -35,7 +34,6 @@ class WP_Meta_Query {
* The relation between the queries. Can be one of 'AND' or 'OR'.
*
* @since 3.2.0
* @access public
* @var string
*/
public $relation;
@@ -44,7 +42,6 @@ class WP_Meta_Query {
* Database table to query for the metadata.
*
* @since 4.1.0
* @access public
* @var string
*/
public $meta_table;
@@ -53,7 +50,6 @@ class WP_Meta_Query {
* Column in meta_table that represents the ID of the object the metadata belongs to.
*
* @since 4.1.0
* @access public
* @var string
*/
public $meta_id_column;
@@ -62,7 +58,6 @@ class WP_Meta_Query {
* Database table that where the metadata's objects are stored (eg $wpdb->users).
*
* @since 4.1.0
* @access public
* @var string
*/
public $primary_table;
@@ -71,7 +66,6 @@ class WP_Meta_Query {
* Column in primary_table that represents the ID of the object.
*
* @since 4.1.0
* @access public
* @var string
*/
public $primary_id_column;
@@ -80,7 +74,6 @@ class WP_Meta_Query {
* A flat list of table aliases used in JOIN clauses.
*
* @since 4.1.0
* @access protected
* @var array
*/
protected $table_aliases = array();
@@ -89,7 +82,6 @@ class WP_Meta_Query {
* A flat list of clauses, keyed by clause 'name'.
*
* @since 4.2.0
* @access protected
* @var array
*/
protected $clauses = array();
@@ -98,7 +90,6 @@ class WP_Meta_Query {
* Whether the query contains any OR relations.
*
* @since 4.3.0
* @access protected
* @var bool
*/
protected $has_or_relation = false;
@@ -109,7 +100,6 @@ class WP_Meta_Query {
* @since 3.2.0
* @since 4.2.0 Introduced support for naming query clauses by associative array keys.
*
* @access public
*
* @param array $meta_query {
* Array of meta query clauses. When first-order clauses or sub-clauses use strings as
@@ -153,7 +143,6 @@ class WP_Meta_Query {
* Eliminates empty items and ensures that a 'relation' is set.
*
* @since 4.1.0
* @access public
*
* @param array $queries Array of query clauses.
* @return array Sanitized array of query clauses.
@@ -222,7 +211,6 @@ class WP_Meta_Query {
* a 'value' array key.
*
* @since 4.1.0
* @access protected
*
* @param array $query Meta query arguments.
* @return bool Whether the query clause is a first-order clause.
@@ -235,7 +223,6 @@ class WP_Meta_Query {
* Constructs a meta query based on 'meta_*' query vars
*
* @since 3.2.0
* @access public
*
* @param array $qv The query variables
*/
@@ -283,7 +270,6 @@ class WP_Meta_Query {
* Return the appropriate alias for the given meta type if applicable.
*
* @since 3.7.0
* @access public
*
* @param string $type MySQL type to cast meta_value.
* @return string MySQL type.
@@ -307,7 +293,6 @@ class WP_Meta_Query {
* Generates SQL clauses to be appended to a main query.
*
* @since 3.2.0
* @access public
*
* @param string $type Type of meta, eg 'user', 'post'.
* @param string $primary_table Database table where the object being filtered is stored (eg wp_users).
@@ -365,7 +350,6 @@ class WP_Meta_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.
@@ -396,7 +380,6 @@ class WP_Meta_Query {
* produce the properly nested SQL.
*
* @since 4.1.0
* @access protected
*
* @param array $query Query to parse, passed by reference.
* @param int $depth Optional. Number of tree levels deep we currently are.
@@ -480,7 +463,6 @@ class WP_Meta_Query {
* "First-order" means that it's an array with a 'key' or 'value'.
*
* @since 4.1.0
* @access public
*
* @global wpdb $wpdb WordPress database abstraction object.
*
@@ -658,7 +640,6 @@ class WP_Meta_Query {
* a value of 'orderby' corresponding to a meta clause.
*
* @since 4.2.0
* @access public
*
* @return array Meta clauses.
*/
@@ -681,7 +662,6 @@ class WP_Meta_Query {
* connected by the relation 'OR'.
*
* @since 4.1.0
* @access protected
*
* @param array $clause Query clause.
* @param array $parent_query Parent query of $clause.