Skip to:
Content

BuddyPress.org

Changeset 10455


Ignore:
Timestamp:
01/18/2016 07:34:34 AM (10 years ago)
Author:
tw2113
Message:

More docs cleanup and @since additions.

See #6396.

Location:
trunk/src/bp-activity
Files:
6 edited

Legend:

Unmodified
Added
Removed

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

    r10375 r10455  
    2323         *
    2424         * @since 1.6.0
    25          *
    2625         * @var BP_Activity_Activity
    2726         */

  • trunk/src/bp-activity/bp-activity-cache.php

    r10417 r10455  
    1717 * in $activity_ids and adds it to the WP cache. This improves efficiency when
    1818 * using querying activitymeta inline.
     19 *
     20 * @since 1.6.0
    1921 *
    2022 * @param int|string|array|bool $activity_ids Accepts a single activity ID, or a comma-

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

    r10428 r10455  
    12551255/**
    12561256 * Generate an activity action string for an activity item.
     1257 *
     1258 * @since 2.0.0
    12571259 *
    12581260 * @param object $activity Activity data object.

  • trunk/src/bp-activity/bp-activity-loader.php

    r10417 r10455  
    390390/**
    391391 * Bootstrap the Activity component.
     392 *
     393 * @since 1.6.0
    392394 */
    393395function bp_setup_activity() {

  • trunk/src/bp-activity/bp-activity-template.php

    r10417 r10455  
    119119         * The loop iterator.
    120120         *
    121          * @since 1.5.0
     121         * @since 1.0.0
    122122         * @var int
    123123         */
    … …  
    127127         * The activity count.
    128128         *
    129          * @since 1.5.0
     129         * @since 1.0.0
    130130         * @var int
    131131         */
    … …  
    135135         * The total activity count.
    136136         *
    137          * @since 1.5.0
     137         * @since 1.0.0
    138138         * @var int
    139139         */
    … …  
    143143         * Array of activities located by the query.
    144144         *
    145          * @since 1.5.0
     145         * @since 1.0.0
    146146         * @var array
    147147         */
    … …  
    151151         * The activity object currently being iterated on.
    152152         *
    153          * @since 1.5.0
     153         * @since 1.0.0
    154154         * @var object
    155155         */
    … …  
    159159         * A flag for whether the loop is currently being iterated.
    160160         *
    161          * @since 1.5.0
     161         * @since 1.0.0
    162162         * @var bool
    163163         */
    … …  
    175175         * The page number being requested.
    176176         *
    177          * @since 1.5.0
     177         * @since 1.0.0
    178178         * @var int
    179179         */
    … …  
    183183         * The number of items being requested per page.
    184184         *
    185          * @since 1.5.0
     185         * @since 1.0.0
    186186         * @var int
    187187         */
    … …  
    191191         * An HTML string containing pagination links.
    192192         *
    193          * @since 1.5.0
     193         * @since 1.0.0
    194194         * @var string
    195195         */
    … …  
    199199         * The displayed user's full name.
    200200         *
    201          * @since 1.5.0
     201         * @since 1.0.0
    202202         * @var string
    203203         */
    … …  
    209209         * The arguments passed to this class constructor are of the same
    210210         * format as {@link BP_Activity_Activity::get()}.
     211         *
     212         * @since 1.5.0
    211213         *
    212214         * @see BP_Activity_Activity::get() for a description of the argument
    … …  
    395397         * Whether there are activity items available in the loop.
    396398         *
     399         * @since 1.0.0
     400         *
    397401         * @see bp_has_activities()
    398402         *
    … …  
    410414         * Set up the next activity item and iterate index.
    411415         *
     416         * @since 1.0.0
     417         *
    412418         * @return object The next activity item to iterate over.
    413419         */
    … …  
    421427        /**
    422428         * Rewind the posts and reset post index.
     429         *
     430         * @since 1.0.0
    423431         */
    424432        public function rewind_activities() {
    … …  
    435443         * that controls iteration inside the activities loop, eg:
    436444         *     while ( bp_activities() ) { ...
     445         *
     446         * @since 1.0.0
    437447         *
    438448         * @see bp_activities()
    … …  
    468478         * data while looping, so that template tags used during that iteration
    469479         * make reference to the current activity item.
     480         *
     481         * @since 1.0.0
    470482         *
    471483         * @see bp_the_activity()

  • trunk/src/bp-activity/classes/class-bp-activity-feed.php

    r10417 r10455  
    4444         *
    4545         * @see BP_Feed::__construct() This is where $data is added.
     46         *
     47         * @since 1.8.0
    4648         * @var array
    4749         */
    … …  
    5153         * Magic method for checking the existence of a certain data variable.
    5254         *
     55         * @since 1.8.0
     56         *
    5357         * @param string $key Property to check.
    54          *
    5558         * @return bool Whether or not data variable exists.
    5659         */
    … …  
    6063         * Magic method for getting a certain data variable.
    6164         *
     65         * @since 1.8.0
     66         *
    6267         * @param string $key Property to get.
    63          *
    6468         * @return mixed Data in variable if available or null.
    6569         */
    … …  
    7882        /**
    7983         * Constructor.
     84         *
     85         * @since 1.8.0
    8086         *
    8187         * @param array $args Optional.
    … …  
    176182        /**
    177183         * Setup and validate the class properties.
     184         *
     185         * @since 1.8.0
    178186         */
    179187        protected function setup_properties() {
    … …  
    199207         * Currently, these hooks are used to maintain backwards compatibility with
    200208         * the RSS feeds previous to BP 1.8.
     209         *
     210         * @since 1.8.0
    201211         */
    202212        protected function setup_hooks() {
    … …  
    210220        /**
    211221         * Fire a hook to ensure backward compatibility for RSS attributes.
     222         *
     223         * @since 1.8.0
    212224         */
    213225        public function backpat_rss_attributes() {
    … …  
    225237        /**
    226238         * Fire a hook to ensure backward compatibility for channel elements.
     239         *
     240         * @since 1.8.0
    227241         */
    228242        public function backpat_channel_elements() {
    … …  
    240254        /**
    241255         * Fire a hook to ensure backward compatibility for item elements.
     256         *
     257         * @since 1.8.0
    242258         */
    243259        public function backpat_item_elements() {
    … …  
    271287        /**
    272288         * Output the feed's item content.
     289         *
     290         * @since 1.8.0
    273291         */
    274292        protected function feed_content() {
    … …  
    374392        /**
    375393         * Output the RSS feed.
     394         *
     395         * @since 1.8.0
    376396         */
    377397        protected function output() {
Note: See TracChangeset for help on using the changeset viewer.