Changeset 7407 for trunk/bp-blogs/bp-blogs-cache.php

Timestamp:

10/10/2013 02:44:05 PM (11 years ago)

Author:

boonebgorges

Message:

Inline docs improvements in Blogs component:

• bp-blogs-actions.php
• bp-blogs-activity.php
• bp-blogs-buddybar.php
• bp-blogs-cache.php
• bp-blogs-classes.php

See #5022

File:

• trunk/bp-blogs/bp-blogs-cache.php (modified) (3 diffs)

trunk/bp-blogs/bp-blogs-cache.php

@@ -2 +2 @@
 
 /**
- * BuddyPress Blogs Caching
+ * BuddyPress Blogs Caching.
  *
  * Caching functions handle the clearing of cached objects and pages on specific
@@ -15 +15 @@
 
 /**
- * Clear the blog object cache
+ * Clear the blog object cache.
  *
  * @since BuddyPress (1.0)
- * @package BuddyPress
- * @subpackage BlogsCache
- * @param int $blog_id
- * @param int $user_id
+ *
+ * @param int $blog_id ID of the current blog.
+ * @param int $user_id ID of the user whose blog cache should be cleared.
  */
 function bp_blogs_clear_blog_object_cache( $blog_id, $user_id ) {
@@ -29 +28 @@
 
 /**
- * Clear cache when a new blog is created
+ * Clear cache when a new blog is created.
  *
  * @since BuddyPress (1.0)
- * @package BuddyPress
- * @subpackage BlogsCache
- * @param BP_Blogs_Blog $recorded_blog_obj
+ *
+ * @param BP_Blogs_Blog $recorded_blog_obj The recorded blog, passed by 'bp_blogs_new_blog'.
  */
 function bp_blogs_format_clear_blog_cache( $recorded_blog_obj ) {