Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/03/2015 06:51:25 PM (9 years ago)
Author:
tw2113
Message:

First pass at cleanup of Activity component documetnation.

See #6396.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-activity/bp-activity-akismet.php

    r9819 r9833  
    7272     * @since BuddyPress (1.6.0)
    7373     *
    74      * @param array $actions The hover links.
     74     * @param array $actions  The hover links.
    7575     * @param array $activity The activity for the current row being processed.
     76     *
    7677     * @return array The hover links.
    7778     */
     
    163164     * @see bp_dtheme_post_update()
    164165     *
    165      * @param string $content Activity update text.
    166      * @param int $user_id User ID.
    167      * @param int $activity_id Activity ID.
     166     * @param string $content     Activity update text.
     167     * @param int    $user_id    User ID.
     168     * @param int    $activity_id Activity ID.
    168169     */
    169170    public function check_member_activity_update( $content, $user_id, $activity_id ) {
     
    263264     * @since BuddyPress (1.6.0)
    264265     *
    265      * @param BP_Activity_Activity $activity
    266      * @param string $source Either "by_a_person" (e.g. a person has manually marked the activity as spam) or "by_akismet" (automatically spammed).
     266     * @param BP_Activity_Activity $activity Activity item being spammed.
     267     * @param string               $source   Either "by_a_person" (e.g. a person has
     268     *                                       manually marked the activity as spam) or
     269     *                                       "by_akismet" (automatically spammed).
    267270     */
    268271    public function mark_as_spam( $activity, $source ) {
     
    276279         *
    277280         * @param BP_Activity_Activity $activity Activity object being marked as spam.
    278          * @param string $source Source of the whom marked as spam. Either "by_a_person" (e.g. a person has manually marked the activity as spam) or "by_akismet".
     281         * @param string               $source   Source of the whom marked as spam.
     282         *                                       Either "by_a_person" (e.g. a person has
     283         *                                       manually marked the activity as spam)
     284         *                                       or "by_akismet".
    279285         */
    280286        do_action( 'bp_activity_akismet_mark_as_spam', $activity, $source );
     
    286292     * @since BuddyPress (1.6.0)
    287293     *
    288      * @param BP_Activity_Activity $activity
    289      * @param string $source Either "by_a_person" (e.g. a person has manually marked the activity as ham) or "by_akismet" (automatically hammed).
     294     * @param BP_Activity_Activity $activity Activity item being hammed.
     295     * @param string               $source   Either "by_a_person" (e.g. a person has
     296     *                                       manually marked the activity as ham) or
     297     *                                       "by_akismet" (automatically hammed).
    290298     */
    291299    public function mark_as_ham( $activity, $source ) {
     
    300308         *
    301309         * @param BP_Activity_Activity $activity Activity object being marked as ham.
    302          * @param string $source Source of the whom marked as ham. Either "by_a_person" (e.g. a person has manually marked the activity as ham) or "by_akismet" (automatically hammed).
     310         * @param string               $source   Source of the whom marked as ham.
     311         *                                       Either "by_a_person" (e.g. a person has
     312         *                                       manually marked the activity as ham) or
     313         *                                       "by_akismet" (automatically hammed).
    303314         */
    304315        do_action( 'bp_activity_akismet_mark_as_ham', $activity, $source );
     
    314325     *
    315326     * @param BP_Activity_Activity $activity Activity item data.
     327     *
     328     * @return array
    316329     */
    317330    public static function build_akismet_data_package( $activity ) {
     
    348361         * @since BuddyPress (1.6.0)
    349362         *
    350          * @param array $activity_data Array of activity data for Akismet to inspect.
    351          * @param BP_Activity_Activity $activity Activity item data.
     363         * @param array                $activity_data Array of activity data for Akismet to inspect.
     364         * @param BP_Activity_Activity $activity      Activity item data.
    352365         */
    353366        return apply_filters( 'bp_akismet_build_akismet_data_package', $activity_data, $activity );
     
    392405             * @since BuddyPress (1.6.0)
    393406             *
    394              * @param BP_Activity_Activity $activity The activity item proven to be spam.
    395              * @param array $activity_data Array of activity data for item including Akismet check results data.
     407             * @param BP_Activity_Activity $activity      The activity item proven to be spam.
     408             * @param array                $activity_data Array of activity data for item including
     409             *                                            Akismet check results data.
    396410             */
    397411            do_action_ref_array( 'bp_activity_akismet_spam_caught', array( &$activity, $activity_data ) );
     
    485499     * @global string $akismet_api_port
    486500     *
    487      * @param array $activity_data Packet of information to submit to Akismet.
    488      * @param string $check "check" or "submit".
    489      * @param string $spam "spam" or "ham".
     501     * @param array  $activity_data Packet of information to submit to Akismet.
     502     * @param string $check         "check" or "submit".
     503     * @param string $spam          "spam" or "ham".
     504     *
    490505     * @return array $activity_data Activity data, with Akismet data added.
    491506     */
     
    562577     *
    563578     * @param string $user_agent User agent string, as generated by Akismet.
     579     *
    564580     * @return string $user_agent Modified user agent string.
    565581     */
     
    611627     * @since BuddyPress (1.6.0)
    612628     *
    613      * @param int $activity_id Activity item ID.
    614      * @param string $message Human-readable description of what's changed.
    615      * @param string $event The type of check we were carrying out.
     629     * @param int    $activity_id Activity item ID.
     630     * @param string $message     Human-readable description of what's changed.
     631     * @param string $event       The type of check we were carrying out.
    616632     */
    617633    public function update_activity_history( $activity_id = 0, $message = '', $event = '' ) {
     
    633649     *
    634650     * @param int $activity_id Activity item ID.
     651     *
    635652     * @return array The activity item's Akismet history.
    636653     */
Note: See TracChangeset for help on using the changeset viewer.