Ticket #5632: capabilities.phpdoc.diff

capabilities.php

@@ -1 +1 @@
 <?php
+/**
+ * {@internal Missing Description}}
+ *
+ * @package WordPress
+ * @subpackage User
+ */
 
 class WP_Roles {
         var $roles;
@@ -130 +136 @@
 
 class WP_User {
         var $data;
+
+        /**
+         * The user's ID.
+         *
+         * @since 2.1.0
+         * @access public
+         * @var int
+         */
         var $ID = 0;
-        var $id = 0; // Deprecated, use $ID instead.
+
+        /**
+         * The user's ID.
+         *
+         * @since 2.0.0
+         * @access public
+         * @deprecated Use WP_User::$ID
+         * @see WP_User::$ID
+         * @var int
+         */
+        var $id = 0;
+
+        /**
+         * The capabilities the user has.
+         *
+         * @since 2.0.0
+         * @access public
+         * @var array
+         */
         var $caps = array();
+
+        /**
+         * {@internal Missing Description}}
+         *
+         * @since 2.0.0
+         * @access public
+         * @var unknown_type
+         */
         var $cap_key;
+
+        /**
+         * The roles the user is part of.
+         *
+         * @since 2.0.0
+         * @access public
+         * @var array
+         */
         var $roles = array();
         var $allcaps = array();
 
@@ -254 +302 @@
                 $this->get_role_caps();
         }
 
-        //has_cap(capability_or_role_name) or
-        //has_cap('edit_post', post_id)
+        /**
+         * {@internal Missing Short Description}}
+         *
+         * has_cap(capability_or_role_name) or has_cap('edit_post', post_id)
+         * {@internal Missing Long Description}}
+         *
+         * @since 2.0.0
+         * @access public
+         *
+         * @param unknown_type $cap
+         * @return unknown
+         */
         function has_cap($cap) {
                 if ( is_numeric($cap) )
                         $cap = $this->translate_level_to_cap($cap);
@@ -280 +338 @@
 
 }
 
-// Map meta capabilities to primitive capabilities.
+/**
+ * map_meta_cap() - Map meta capabilities to primitive capabilities
+ *
+ * {@internal Missing Long Description}}
+ *
+ * @since 2.0.0
+ *
+ * @param unknown_type $cap
+ * @param unknown_type $user_id
+ * @return unknown
+ */
 function map_meta_cap($cap, $user_id) {
         $args = array_slice(func_get_args(), 2);
         $caps = array();
@@ -440 +508 @@
         return $caps;
 }
 
-// Capability checking wrapper around the global $current_user object.
+/**
+ * current_user_can() - Capability checking wrapper around the global $current_user object
+ *
+ * {@internal Missing Long Description}}
+ *
+ * @since 2.0.0
+ *
+ * @param unknown_type $capability
+ * @return unknown
+ */
 function current_user_can($capability) {
         $current_user = wp_get_current_user();
 
@@ -453 +530 @@
         return call_user_func_array(array(&$current_user, 'has_cap'), $args);
 }
 
-// Convenience wrappers around $wp_roles.
+/**
+ * get_role() - Convenience wrappers around $wp_roles.
+ *
+ * {@internal Missing Long Description}}
+ *
+ * @since 2.0.0
+ *
+ * @param unknown_type $role
+ * @return unknown
+ */
 function get_role($role) {
         global $wp_roles;