Skip to:
Content

BuddyPress.org


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

More docs cleanup and @since additions.

See #6396.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • 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()
Note: See TracChangeset for help on using the changeset viewer.