Skip to:
Content

BuddyPress.org

Changeset 9025


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

Improve inline documentation for Notifications component.

See #5022

Location:
trunk/src/bp-notifications
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-notifications/bp-notifications-actions.php

    r8958 r9025  
    2020 * @since BuddyPress (1.9.0)
    2121 *
    22  * @return boolean
     22 * @return bool
    2323 */
    2424function bp_notifications_action_mark_read() {
     
    5656 * @since BuddyPress (1.9.0)
    5757 *
    58  * @return boolean
     58 * @return bool
    5959 */
    6060function bp_notifications_action_mark_unread() {
     
    9292 * @since BuddyPress (1.9.0)
    9393 *
    94  * @return boolean
     94 * @return bool
    9595 */
    9696function bp_notifications_action_delete() {
  • trunk/src/bp-notifications/bp-notifications-classes.php

    r8958 r9025  
    2727     * The notification ID.
    2828     *
     29     * @since BuddyPress (1.9.0)
     30     * @access public
    2931     * @var int
    3032     */
     
    3436     * The ID of the item associated with the notification.
    3537     *
     38     * @since BuddyPress (1.9.0)
     39     * @access public
    3640     * @var int
    3741     */
     
    4145     * The ID of the secondary item associated with the notification.
    4246     *
     47     * @since BuddyPress (1.9.0)
     48     * @access public
    4349     * @var int
    4450     */
     
    4854     * The ID of the user the notification is associated with.
    4955     *
     56     * @since BuddyPress (1.9.0)
     57     * @access public
    5058     * @var int
    5159     */
     
    5563     * The name of the component that the notification is for.
    5664     *
     65     * @since BuddyPress (1.9.0)
     66     * @access public
    5767     * @var string
    5868     */
     
    6272     * The component action which the notification is related to.
    6373     *
     74     * @since BuddyPress (1.9.0)
     75     * @access public
    6476     * @var string
    6577     */
     
    6981     * The date the notification was created.
    7082     *
     83     * @since BuddyPress (1.9.0)
     84     * @access public
    7185     * @var string
    7286     */
     
    7690     * Is the notification new, or has it already been read.
    7791     *
     92     * @since BuddyPress (1.9.0)
     93     * @access public
    7894     * @var bool
    7995     */
     
    693709    }
    694710
    695     /** Convenience methods ***************************************************/
     711    /** Convenience methods ***********************************************/
    696712
    697713    /**
     
    806822    }
    807823
    808     /** Mark ******************************************************************/
     824    /** Mark **************************************************************/
    809825
    810826    /**
  • 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() {
  • trunk/src/bp-notifications/bp-notifications-loader.php

    r8958 r9025  
    5656
    5757    /**
    58      * Setup globals
    59      *
    60      * The BP_FRIENDS_SLUG constant is deprecated, and only used here for
    61      * backwards compatibility.
     58     * Set up component global data.
    6259     *
    6360     * @since BuddyPress (1.9.0)
  • trunk/src/bp-notifications/bp-notifications-template.php

    r8958 r9025  
    4343     * @since BuddyPress (1.9.0)
    4444     *
    45      * @return string Notifications permalink
     45     * @return string Notifications permalink.
    4646     */
    4747    function bp_get_notifications_permalink() {
     
    6363     * @since BuddyPress (1.9.0)
    6464     *
    65      * @return string Unread notifications permalink
     65     * @return string Unread notifications permalink.
    6666     */
    6767    function bp_get_notifications_unread_permalink() {
     
    8383     * @since BuddyPress (1.9.0)
    8484     *
    85      * @return string Read notifications permalink
     85     * @return string Read notifications permalink.
    8686     */
    8787    function bp_get_notifications_read_permalink() {
     
    943943     *
    944944     * @param array $args {
    945      *     @type string $before HTML before the links
    946      *     @type string $after HTML after the links
    947      *     @type string $sep HTML between the links
    948      *     @type array $links Array of links to implode by 'sep'
     945     *     @type string $before HTML before the links.
     946     *     @type string $after HTML after the links.
     947     *     @type string $sep HTML between the links.
     948     *     @type array $links Array of links to implode by 'sep'.
    949949     * }
    950950     *
Note: See TracChangeset for help on using the changeset viewer.