Skip to:
Content

BuddyPress.org

Changeset 7401


Ignore:
Timestamp:
10/08/2013 08:58:13 PM (11 years ago)
Author:
boonebgorges
Message:

Improve inline docs in bp-activity-notifications.php

See #5022

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/bp-activity/bp-activity-notifications.php

    r6917 r7401  
    22
    33/**
    4  * BuddyPress Activity Notifications
     4 * BuddyPress Activity Notifications.
    55 *
    66 * @package BuddyPress
    … …  
    1212
    1313/**
    14  * Sends an email notification and a BP notification when someone mentions you in an update
     14 * Send email and BP notifications when a user is mentioned in an update.
    1515 *
    1616 * @since BuddyPress (1.2)
    17  *
    18  * @param int $activity_id The id of the activity update
    19  * @param int $receiver_user_id The unique user_id of the user who is receiving the update
    2017 *
    2118 * @uses bp_core_add_notification()
    … …  
    3229 * @uses bp_is_group()
    3330 * @uses bp_get_current_group_name()
    34  * @uses apply_filters() To call the 'bp_activity_at_message_notification_to' hook
    35  * @uses apply_filters() To call the 'bp_activity_at_message_notification_subject' hook
    36  * @uses apply_filters() To call the 'bp_activity_at_message_notification_message' hook
     31 * @uses apply_filters() To call the 'bp_activity_at_message_notification_to' hook.
     32 * @uses apply_filters() To call the 'bp_activity_at_message_notification_subject' hook.
     33 * @uses apply_filters() To call the 'bp_activity_at_message_notification_message' hook.
    3734 * @uses wp_mail()
    3835 * @uses do_action() To call the 'bp_activity_sent_mention_email' hook
     36 *
     37 * @param int $activity_id The ID of the activity update.
     38 * @param int $receiver_user_id The ID of the user who is receiving the update.
    3939 */
    4040function bp_activity_at_message_notification( $activity_id, $receiver_user_id ) {
    … …  
    113113
    114114/**
    115  * Sends an email notification and a BP notification when someone mentions you in an update
     115 * Send email and BP notifications when an activity item receives a comment.
    116116 *
    117117 * @since BuddyPress (1.2)
    118  *
    119  * @param int $comment_id The comment id
    120  * @param int $commenter_id The unique user_id of the user who posted the comment
    121  * @param array $params {@link bp_activity_new_comment()}
    122118 *
    123119 * @uses bp_get_user_meta()
    … …  
    140136 * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_message' hook
    141137 * @uses do_action() To call the 'bp_activity_sent_reply_to_reply_email' hook
     138 *
     139 * @param int $comment_id The comment id.
     140 * @param int $commenter_id The ID of the user who posted the comment.
     141 * @param array $params {@link bp_activity_new_comment()}
    142142 */
    143143function bp_activity_new_comment_notification( $comment_id, $commenter_id, $params ) {
Note: See TracChangeset for help on using the changeset viewer.