Ticket #5633: category.phpdoc.diff

category.php

@@ -1 +1 @@
 <?php
+/**
+ * 
+ *
+ * @package WordPress
+ */
 
 function get_all_category_ids() {
         if ( ! $cat_ids = wp_cache_get('all_category_ids', 'category') ) {
@@ -24 +29 @@
         return $categories;
 }
 
-// Retrieves category data given a category ID or category object.
-// Handles category caching.
+/**
+ * get_category() - Retrieves category data given a category ID or category object
+ *
+ * Handles category caching.
+ * {@internal Missing Long Description}}
+ *
+ * @since 2.1.0
+ *
+ * @param unknown_type $category
+ * @param unknown_type $output
+ * @param unknown_type $filter
+ * @return unknown
+ */
 function &get_category($category, $output = OBJECT, $filter = 'raw') {
         $category = get_term($category, 'category', $output, $filter);
         if ( is_wp_error( $category ) )
@@ -81 +97 @@
         return $category;
 }
 
-// Get the ID of a category from its name
+/**
+ * get_cat_ID() - Get the ID of a category from its name
+ *
+ * {@internal Missing Long Description}}
+ *
+ * @since 1.0.0
+ *
+ * @param string $cat_name
+ * @return int
+ */
 function get_cat_ID($cat_name='General') {
         $cat = get_term_by('name', $cat_name, 'category');
         if ($cat)
@@ -89 +114 @@
         return 0;
 }
 
-// Deprecate
+/**
+ * get_catname() - Get the nategory name by Category ID
+ *
+ * @since 0.71
+ * @deprecated Use get_cat_name()
+ * @see get_cat_name() get_catname() is deprecated in favor of get_cat_name()
+ *
+ * @param int $cat_ID Category ID
+ * @return string category name
+ */
 function get_catname($cat_ID) {
         return get_cat_name($cat_ID);
 }
 
-// Get the name of a category from its ID
+/**
+ * get_cat_name() - Get the name of a category from its ID
+ *
+ * {@internal Missing Long Description}}
+ *
+ * @since 1.0.0
+ *
+ * @param int $cat_id Category ID
+ * @return string category name
+ */
 function get_cat_name($cat_id) {
         $cat_id = (int) $cat_id;
         $category = &get_category($cat_id);