Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/17/2014 12:05:45 AM (11 years ago)
Author:
boonebgorges
Message:

Improve inline documentation for Notifications component.

See #5022

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-notifications/bp-notifications-functions.php

    r8958 r9025  
    114114 *
    115115 * @param int $id ID of the user whose notifications are being deleted.
    116  * @param int $is_new 0 for read, 1 for unread
     116 * @param int $is_new 0 for read, 1 for unread.
    117117 * @return bool True on success, false on failure.
    118118 */
    … …  
    129129
    130130/**
    131  * Get all notifications for a user and cache them
     131 * Get all notifications for a user and cache them.
    132132 *
    133133 * @since BuddyPress (2.1.0)
    134134 *
    135  * @param int $user_id
     135 * @param int $user_id ID of the user whose notifications are being fetched.
    136136 * @return array
    137137 */
    … …  
    161161 * @since BuddyPress (1.9.0)
    162162 *
    163  * @param int $user_id ID of the user whose notification are being fetched.
     163 * @param int $user_id ID of the user whose notifications are being fetched.
    164164 * @param string $format Format of the returned values. 'string' returns HTML,
    165165 *        while 'object' returns a structured object for parsing.
    … …  
    404404 * @param string $component_name Name of the associated component.
    405405 * @param string $component_action Name of the associated action.
    406  * @param int $is_new 0 for read, 1 for unread
     406 * @param int $is_new 0 for read, 1 for unread.
    407407 * @return bool True on success, false on failure.
    408408 */
    … …  
    433433 * @param string $component_action Name of the associated action.
    434434 * @param int $secondary_item_id ID of the secondary associated item.
    435  * @param int $is_new 0 for read, 1 for unread
     435 * @param int $is_new 0 for read, 1 for unread.
    436436 * @return bool True on success, false on failure.
    437437 */
    … …  
    463463 * @param string $component_action Optional. Name of the associated action.
    464464 * @param int $secondary_item_id Optional. ID of the secondary associated item.
    465  * @param int $is_new 0 for read, 1 for unread
     465 * @param int $is_new 0 for read, 1 for unread.
    466466 * @return bool True on success, false on failure.
    467467 */
    … …  
    495495 * @param string $component_name Name of the associated component.
    496496 * @param string $component_action Name of the associated action.
    497  * @param int $is_new 0 for read, 1 for unread
     497 * @param int $is_new 0 for read, 1 for unread.
    498498 * @return bool True on success, false on failure.
    499499 */
    … …  
    551551 *
    552552 * @see http://buddypress.trac.wordpress.org/ticket/5300
     553 *
     554 * @return array
    553555 */
    554556function bp_notifications_get_registered_components() {
Note: See TracChangeset for help on using the changeset viewer.