Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
10/10/2013 02:44:05 PM (10 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/bp-blogs/bp-blogs-activity.php

    r7228 r7407  
    22
    33/**
    4  * BuddyPress Blogs Activity
     4 * BuddyPress Blogs Activity.
    55 *
    66 * @package BuddyPress
     
    1212
    1313/**
    14  * Register activity actions for the blogs component
     14 * Register activity actions for the blogs component.
    1515 *
    1616 * @since BuddyPress (1.0)
    17  * @package BuddyPress
    18  * @subpackage BlogsActivity
    19  * @global type $bp
    20  * @return boolean
     17 *
     18 * @global object $bp The BuddyPress global settings object.
     19 *
     20 * @return bool|null Returns false if activity component is not active.
    2121 */
    2222function bp_blogs_register_activity_actions() {
     
    4040
    4141/**
    42  * Record the activity to the actvity stream
     42 * Record blog-related activity to the activity stream.
    4343 *
    4444 * @since BuddyPress (1.0)
    45  * @package BuddyPress
    46  * @subpackage BlogsActivity
    47  * @global BuddyPress $bp
    48  * @param array $args
    49  * @return boolean
     45 *
     46 * @see bp_activity_add() for description of parameters.
     47 * @global object $bp The BuddyPress global settings object.
     48 *
     49 * @param array $args {
     50 *     See {@link bp_activity_add()} for complete description of arguments.
     51 *     The arguments listed here have different default values from bp_activity_add().
     52 *     @type string $component Default: 'blogs'.
     53 * }
     54 * @return int|bool On success, returns the activity ID. False on failure.
    5055 */
    5156function bp_blogs_record_activity( $args = '' ) {
     
    95100
    96101/**
    97  * Delete a blogs activity stream item
     102 * Delete a blog-related activity stream item.
    98103 *
    99104 * @since BuddyPress (1.0)
    100  * @package BuddyPress
    101  * @subpackage BlogsActivity
    102  * @global BuddyPress $bp
    103  * @param array $args
     105 *
     106 * @see bp_activity_delete() for description of parameters.
     107 * @global object $bp The BuddyPress global settings object.
     108 *
     109 * @param array $args {
     110 *     See {@link bp_activity_delete()} for complete description of arguments.
     111 *     The arguments listed here have different default values from bp_activity_add().
     112 *     @type string $component Default: 'blogs'.
     113 * }
     114 * @return bool True on success, false on failure.
    104115 */
    105116function bp_blogs_delete_activity( $args = true ) {
Note: See TracChangeset for help on using the changeset viewer.