Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
08/18/2012 10:15:09 AM (14 years ago)
Author:
djpaul
Message:

Update @since phpdoc on functions to use our formatted version of the tag, e.g. "@since BuddyPress (1.6)". Fixes #4445, props fanquake

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r6184 r6259  
    44 *
    55 * @package BuddyPress
    6  * @since 1.6
     6 * @since BuddyPress (1.6)
    77 * @subpackage Activity
    88 */
    … …  
    1717         * @access protected
    1818         * @var BP_Activity_Activity
    19          * @since 1.6
     19         * @since BuddyPress (1.6)
    2020         */
    2121        protected $last_activity = null;
    … …  
    2424         * Constructor
    2525         *
    26          * @since 1.6
     26         * @since BuddyPress (1.6)
    2727         */
    2828        public function __construct() {
    … …  
    3333         * Hook Akismet into the activity stream
    3434         *
    35          * @since 1.6
     35         * @since BuddyPress (1.6)
    3636         */
    3737        protected function setup_actions() {
    … …  
    6868         * @param array $activity The activity for the current row being processed
    6969         * @return array The hover links
    70          * @since 1.6
     70         * @since BuddyPress (1.6)
    7171         */
    7272        function comment_row_action( $actions, $activity ) {
    … …  
    115115         *
    116116         * @see http://plugins.trac.wordpress.org/ticket/1232
    117          * @since 1.6
     117         * @since BuddyPress (1.6)
    118118         */
    119119        public function add_activity_stream_nonce() {
    … …  
    139139         * @param int $activity_id Activity ID
    140140         * @see bp_dtheme_post_update()
    141          * @since 1.6
     141         * @since BuddyPress (1.6)
    142142         */
    143143        public function check_member_activity_update( $content, $user_id, $activity_id ) {
    … …  
    159159         * This function is intended to be used inside the activity stream loop.
    160160         *
    161          * @since 1.6
     161         * @since BuddyPress (1.6)
    162162         */
    163163        public function add_activity_spam_button() {
    … …  
    187187         * This function is intended to be used inside the activity stream loop.
    188188         *
    189          * @since 1.6
     189         * @since BuddyPress (1.6)
    190190         */
    191191        public function add_activity_comment_spam_button() {
    … …  
    215215         *
    216216         * @return array List of activity types
    217          * @since 1.6
     217         * @since BuddyPress (1.6)
    218218         * @static
    219219         */
    … …  
    227227         * @param BP_Activity_Activity $activity
    228228         * @param string $source Either "by_a_person" (e.g. a person has manually marked the activity as spam) or "by_akismet" (automatically spammed).
    229          * @since 1.6
     229         * @since BuddyPress (1.6)
    230230         */
    231231        public function mark_as_spam( $activity, $source ) {
    … …  
    241241         * @param BP_Activity_Activity $activity
    242242         * @param string $source Either "by_a_person" (e.g. a person has manually marked the activity as ham) or "by_akismet" (automatically hammed).
    243          * @since 1.6
     243         * @since BuddyPress (1.6)
    244244         */
    245245        public function mark_as_ham( $activity, $source ) {
    … …  
    256256         * @param BP_Activity_Activity $activity
    257257         * @see http://akismet.com/development/api/#comment-check
    258          * @since 1.6
     258         * @since BuddyPress (1.6)
    259259         * @static
    260260         */
    … …  
    295295         * @param BP_Activity_Activity $activity The activity item to check
    296296         * @see http://akismet.com/development/api/
    297          * @since 1.6
     297         * @since BuddyPress (1.6)
    298298         * @todo Spam counter?
    299299         * @todo Auto-delete old spam?
    … …  
    336336         *
    337337         * @param BP_Activity_Activity $activity The activity to check
    338          * @since 1.6
     338         * @since BuddyPress (1.6)
    339339         */
    340340        public function update_activity_spam_meta( $activity ) {
    … …  
    352352         *
    353353         * @param BP_Activity_Activity $activity The activity to check
    354          * @since 1.6
     354         * @since BuddyPress (1.6)
    355355         */
    356356        public function update_activity_ham_meta( $activity ) {
    … …  
    368368         *
    369369         * @param BP_Activity_Activity $activity The activity to check
    370          * @since 1.6
     370         * @since BuddyPress (1.6)
    371371         */
    372372        public function update_activity_akismet_meta( $activity ) {
    … …  
    409409         * @param string $check "check" or "submit"
    410410         * @param string $spam "spam" or "ham"
    411          * @since 1.6
     411         * @since BuddyPress (1.6)
    412412         */
    413413        public function send_akismet_request( $activity_data, $check = 'check', $spam = 'spam' ) {
    … …  
    481481         *
    482482         * @param string $user_agent
    483          * @since 1.6
     483         * @since BuddyPress (1.6)
    484484         */
    485485        public function buddypress_ua( $user_agent ) {
    … …  
    492492         *
    493493         * @param string $screen_action The type of screen that has been requested
    494          * @since 1.6
     494         * @since BuddyPress (1.6)
    495495         */
    496496        function add_history_metabox( $screen_action ) {
    … …  
    507507         *
    508508         * @param object $item Activity item
    509          * @since 1.6
     509         * @since BuddyPress (1.6)
    510510         * @todo Update activity meta to allow >1 record with the same key (iterate through $history).
    511511         * @see http://buddypress.trac.wordpress.org/ticket/3907
    … …  
    528528         * @param string $message Human-readable description of what's changed
    529529         * @param string $event The type of check we were carrying out
    530          * @since 1.6
     530         * @since BuddyPress (1.6)
    531531         */
    532532        public function update_activity_history( $activity_id = 0, $message = '', $event = '' ) {
    … …  
    547547         * @param int $activity_id Activity item ID
    548548         * @return array The activity item's Akismet history
    549          * @since 1.6
     549         * @since BuddyPress (1.6)
    550550         */
    551551        public function get_activity_history( $activity_id = 0 ) {
    … …  
    566566 * @global object $bp BuddyPress global settings
    567567 * @global wpdb $wpdb WordPress database object
    568  * @since 1.6
     568 * @since BuddyPress (1.6)
    569569 */
    570570function bp_activity_akismet_delete_old_metadata() {
Note: See TracChangeset for help on using the changeset viewer.