Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
07/04/2015 10:17:42 PM (9 years ago)
Author:
tw2113
Message:

Docs cleanup for Notifications component.

See #6404.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r9819 r9993  
    22
    33/**
    4  * BuddyPress Notifications Template Functions
     4 * BuddyPress Notifications Template Functions.
    55 *
    66 * @package BuddyPress
    … …  
    206206
    207207    /**
    208      * The $_GET argument used in URLs for determining pagination
     208     * The $_GET argument used in URLs for determining pagination.
    209209     *
    210210     * @since BuddyPress (1.9.0)
    … …  
    251251
    252252    /**
    253      * The direction to sort the results (ASC or DESC)
     253     * The direction to sort the results (ASC or DESC).
    254254     *
    255255     * @since BuddyPress (1.9.0)
    … …  
    260260
    261261    /**
    262      * Array of variables used in this notification query
     262     * Array of variables used in this notification query.
    263263     *
    264264     * @since BuddyPress (2.2.2)
    … …  
    434434     *
    435435     * @return bool True if there are more notifications to show,
    436      *         otherwise false.
     436     *              otherwise false.
    437437     */
    438438    public function notifications() {
    … …  
    496496 * @since BuddyPress (1.9.0)
    497497 *
    498  * @param array $args {
     498 * @param array|string $args {
    499499 *     Arguments for limiting the contents of the notifications loop. Can be
    500500 *     passed as an associative array, or as a URL query string.
    … …  
    503503 *     information on the arguments.  In addition, also supports:
    504504 *
    505  *     @type int $max Optional. Max items to display. Default: false.
     505 *     @type int    $max      Optional. Max items to display. Default: false.
    506506 *     @type string $page_arg URL argument to use for pagination.
    507  *           Default: 'npage'.
     507 *                            Default: 'npage'.
    508508 * }
     509 *
     510 * @return bool
    509511 */
    510512function bp_has_notifications( $args = '' ) {
    … …  
    874876
    875877/**
    876  * Output the URL used for marking a single notification as read
     878 * Output the URL used for marking a single notification as read.
    877879 *
    878880 * Since this function directly outputs a URL, it is escaped.
    … …  
    886888}
    887889    /**
    888      * Return the URL used for marking a single notification as read
     890     * Return the URL used for marking a single notification as read.
    889891     *
    890892     * @since BuddyPress (2.1.0)
    … …  
    952954
    953955/**
    954  * Output the URL used for marking a single notification as unread
     956 * Output the URL used for marking a single notification as unread.
    955957 *
    956958 * Since this function directly outputs a URL, it is escaped.
    … …  
    964966}
    965967    /**
    966      * Return the URL used for marking a single notification as unread
     968     * Return the URL used for marking a single notification as unread.
    967969     *
    968970     * @since BuddyPress (2.1.0)
    … …  
    10631065
    10641066/**
    1065  * Output the URL used for deleting a single notification
     1067 * Output the URL used for deleting a single notification.
    10661068 *
    10671069 * Since this function directly outputs a URL, it is escaped.
    … …  
    10761078}
    10771079    /**
    1078      * Return the URL used for deleting a single notification
     1080     * Return the URL used for deleting a single notification.
    10791081     *
    10801082     * @since BuddyPress (2.1.0)
    … …  
    11191121 * Output the action links for the current notification.
    11201122 *
     1123 * @param array|string $args Array of arguments.
    11211124 * @since BuddyPress (1.9.0)
    11221125 */
    … …  
    11291132     * @since BuddyPress (1.9.0)
    11301133     *
    1131      * @param array $args {
     1134     * @param array|string $args {
    11321135     *     @type string $before HTML before the links.
    1133      *     @type string $after HTML after the links.
    1134      *     @type string $sep HTML between the links.
    1135      *     @type array $links Array of links to implode by 'sep'.
     1136     *     @type string $after  HTML after the links.
     1137     *     @type string $sep    HTML between the links.
     1138     *     @type array  $links Array of links to implode by 'sep'.
    11361139     * }
    11371140     *
    … …  
    12321235
    12331236/**
    1234  * Output the form for changing the sort order of notifications
     1237 * Output the form for changing the sort order of notifications.
    12351238 *
    12361239 * @since BuddyPress (1.9.0)
Note: See TracChangeset for help on using the changeset viewer.