Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/12/2015 04:39:07 AM (10 years ago)
Author:
tw2113
Message:

First pass at messages component docs cleanup.

See #6403.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-messages/classes/class-bp-messages-notice.php

    r9819 r9862  
    110110         * @since BuddyPress (1.0.0)
    111111         *
    112          * @param BP_Messages_Notice Current instance of the message notice item being saved. Passed by reference.
     112         * @param BP_Messages_Notice $this Current instance of the message notice item being saved. Passed by reference.
    113113         */
    114114        do_action_ref_array( 'messages_notice_before_save', array( &$this ) );
    … …  
    138138         * @since BuddyPress (1.0.0)
    139139         *
    140          * @param BP_Messages_Notice Current instance of the message item being saved. Passed by reference.
     140         * @param BP_Messages_Notice $this Current instance of the message item being saved. Passed by reference.
    141141         */
    142142        do_action_ref_array( 'messages_notice_after_save', array( &$this ) );
    … …  
    184184         * @since BuddyPress (1.0.0)
    185185         *
    186          * @param BP_Messages_Notice Current instance of the message notice item being deleted.
     186         * @param BP_Messages_Notice $this Current instance of the message notice item being deleted.
    187187         */
    188188        do_action( 'messages_notice_before_delete', $this );
    … …  
    203203     * Pulls up a list of notices.
    204204     *
    205      * To get all notices, pass a value of -1 to pag_num
     205     * To get all notices, pass a value of -1 to pag_num.
    206206     *
    207207     * @since BuddyPress (1.0.0)
    … …  
    209209     * @param array $args {
    210210     *     Array of parameters.
    211      *     @type int $pag_num Number of notices per page. Defaults to 20.
     211     *     @type int $pag_num  Number of notices per page. Defaults to 20.
    212212     *     @type int $pag_page The page number.  Defaults to 1.
    213213     * }
    … …  
    256256     * @since BuddyPress (1.0.0)
    257257     *
    258      * @return object The BP_Messages_Notice object
     258     * @return object The BP_Messages_Notice object.
    259259     */
    260260    public static function get_active() {
Note: See TracChangeset for help on using the changeset viewer.