Changeset 29455

Timestamp:

08/09/2014 07:31:35 PM (10 years ago)

Author:

DrewAPicture

Message:

Clean up some missing @access tags and other tweaks for 4.0.0-functionality docs.

See #28885.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-plugin-install-list-table.php (modified) (1 diff)
• wp-includes/class-wp-embed.php (modified) (1 diff)
• wp-includes/media.php (modified) (2 diffs)
• wp-includes/session.php (modified) (25 diffs)

trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php

@@ -26 +26 @@
      *
      * @since 4.0.0
+     * @access protected
      */
     protected function get_installed_plugin_slugs() {

trunk/src/wp-includes/class-wp-embed.php

@@ -195 +195 @@
 
             /**
-             * Filter the oEmbed TTL (time to live).
+             * Filter the oEmbed TTL value (time to live).
              *
              * @since 4.0.0

trunk/src/wp-includes/media.php

@@ -2298 +2298 @@
  *
  * @param array  $matches The regex matches from the provided regex when calling
- *                        {@link wp_embed_register_handler()}.
+ *                        {@see wp_embed_register_handler()}.
  * @param array  $attr    Embed attributes.
  * @param string $url     The original URL that was matched by the regex.
@@ -3302 +3302 @@
  *
  * @global $wp_version
+ *
  * @return array The relevant CSS file URLs.
  */

trunk/src/wp-includes/session.php

@@ -11 +11 @@
      *
      * @since 4.0.0
-     *
+     * @access protected
      * @var int User ID.
      */
@@ -32 +32 @@
      *
      * @since 4.0.0
+     * @access public
+     * @static
      *
      * @param int $user_id User whose session to manage.
@@ -52 +54 @@
      *
      * @since 4.0.0
+     * @access private
      *
      * @param string $token Token to hash.
@@ -66 +69 @@
      *
      * @since 4.0.0
+     * @access public
      *
      * @param string $token Token to verify.
@@ -84 +88 @@
      *
      * @since 4.0.0
+     * @access public
      *
      * @param int $expiration Session expiration timestamp.
@@ -114 +119 @@
      *
      * @since 4.0.0
+     * @access public
      *
      * @param string $token Token to update.
@@ -127 +133 @@
      *
      * @since 4.0.0
+     * @access public
      *
      * @param string $token Token to destroy.
@@ -140 +147 @@
      *
      * @since 4.0.0
+     * @access public
      *
      * @param string $token_to_keep Token to keep.
@@ -158 +166 @@
      *
      * @since 4.0.0
+     * @access protected
      *
      * @param array $session Session to check.
@@ -170 +179 @@
      *
      * @since 4.0.0
+     * @access public
      */
     final public function destroy_all_tokens() {
@@ -179 +189 @@
      *
      * @since 4.0.0
+     * @access public
+     * @static
      */
     final public static function destroy_all_tokens_for_all_users() {
@@ -189 +201 @@
      *
      * @since 4.0.0
+     * @access public
      *
      * @return array Sessions of a user.
@@ -200 +213 @@
      *
      * @since 4.0.0
+     * @access protected
      *
      * @return array Sessions of a user, keyed by verifier.
@@ -209 +223 @@
      *
      * @since 4.0.0
+     * @access protected
      *
      * @param $verifier Verifier of the session to retrieve.
@@ -221 +236 @@
      *
      * @since 4.0.0
+     * @access protected
      *
      * @param $verifier Verifier of the session to update.
@@ -231 +247 @@
      *
      * @since 4.0.0
+     * @access protected
      *
      * @param $verifier Verifier of the session to keep.
@@ -240 +257 @@
      *
      * @since 4.0.0
+     * @access protected
      */
     abstract protected function destroy_all_sessions();
@@ -247 +265 @@
      *
      * @since 4.0.0
+     * @access public
+     * @static
      */
     public static function drop_sessions() {}
@@ -262 +282 @@
      *
      * @since 4.0.0
+     * @access protected
      *
      * @return array Sessions of a user.
@@ -294 +315 @@
      *
      * @since 4.0.0
+     * @access protected
      *
      * @param $verifier Verifier of the session to retrieve.
@@ -311 +333 @@
      * Update a session by its verifier.
      *
-     * Omitting the second argument destroys the session.
-     *
-     * @since 4.0.0
-     *
-     * @param $verifier Verifier of the session to update.
+     * @since 4.0.0
+     * @access protected
+     *
+     * @param string $verifier Verifier of the session to update.
+     * @param array  $session  Optional. Session. Omitting this argument destroys the session.
      */
     protected function update_session( $verifier, $session = null ) {
@@ -333 +355 @@
      *
      * @since 4.0.0
-     *
-     * @param array $sessions
+     * @access protected
+     *
+     * @param array $sessions Sessions.
      */
     protected function update_sessions( $sessions ) {
@@ -352 +375 @@
      *
      * @since 4.0.0
+     * @access protected
      *
      * @param $verifier Verifier of the session to keep.
@@ -364 +388 @@
      *
      * @since 4.0.0
+     * @access protected
      */
     protected function destroy_all_sessions() {
@@ -373 +398 @@
      *
      * @since 4.0.0
+     * @access public
+     * @static
      */
     public static function drop_sessions() {