Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
03/18/2018 09:56:44 PM (8 years ago)
Author:
djpaul
Message:

Templates, Nouveau: fix @since PHPDoc.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-templates/bp-nouveau/includes/groups/template-tags.php

    r11896 r11899  
    33 * Groups Template tags
    44 *
    5  * @since 1.0.0
     5 * @since 3.0.0
    66 */
    77
    … …  
    1313 * before the groups directory content
    1414 *
    15  * @since 1.0.0
     15 * @since 3.0.0
    1616 */
    1717function bp_nouveau_before_groups_directory_content() {
    … …  
    4242 * after the groups directory content
    4343 *
    44  * @since 1.0.0
     44 * @since 3.0.0
    4545 */
    4646function bp_nouveau_after_groups_directory_content() {
    … …  
    7777 * Fire specific hooks into the groups create template.
    7878 *
    79  * @since 1.0.0
     79 * @since 3.0.0
    8080 *
    8181 * @param string $when   Optional. Either 'before' or 'after'.
    … …  
    102102 * Fire specific hooks into the single groups templates.
    103103 *
    104  * @since 1.0.0
     104 * @since 3.0.0
    105105 *
    106106 * @param string $when   Optional. Either 'before' or 'after'.
    … …  
    127127 * Fire an isolated hook inside the groups loop
    128128 *
    129  * @since 1.0.0
     129 * @since 3.0.0
    130130 */
    131131function bp_nouveau_groups_loop_item() {
    … …  
    141141 * Display the current group activity post form if needed
    142142 *
    143  * @since 1.0.0
     143 * @since 3.0.0
    144144 */
    145145function bp_nouveau_groups_activity_post_form() {
    … …  
    166166 * Load the Group Invites UI.
    167167 *
    168  * @since 1.0.0
     168 * @since 3.0.0
    169169 *
    170170 * @return string HTML Output.
    … …  
    191191 * Gets the displayed user group invites preferences
    192192 *
    193  * @since 1.0.0
     193 * @since 3.0.0
    194194 *
    195195 * @return int Returns 1 if user chose to restrict to friends, 0 otherwise.
    … …  
    202202 * Outputs the group creation numbered steps navbar
    203203 *
    204  * @since 1.0.0
     204 * @since 3.0.0
    205205 *
    206206 * @todo This output isn't localised correctly.
    … …  
    243243     * @since 1.0.0
    244244     */
    245 
    246245    do_action( 'groups_creation_tabs' );
    247246}
    … …  
    250249 * Load the requested Create Screen for the new group.
    251250 *
    252  * @since 1.0.0
     251 * @since 3.0.0
    253252 */
    254253function bp_nouveau_group_creation_screen() {
    … …  
    259258 * Load the requested Manage Screen for the current group.
    260259 *
    261  * @since 1.0.0
     260 * @since 3.0.0
    262261 */
    263262
    … …  
    444443 * Output the action buttons for the displayed group
    445444 *
    446  * @since 1.0.0
     445 * @since 3.0.0
    447446 *
    448447 * @param array $args Optional. See bp_nouveau_wrapper() for the description of parameters.
    … …  
    481480 * Output the action buttons inside the groups loop.
    482481 *
    483  * @since 1.0.0
     482 * @since 3.0.0
    484483 *
    485484 * @param array $args Optional. See bp_nouveau_wrapper() for the description of parameters.
    … …  
    513512 * Output the action buttons inside the invites loop of the displayed user.
    514513 *
    515  * @since 1.0.0
     514 * @since 3.0.0
    516515 *
    517516 * @param array $args Optional. See bp_nouveau_wrapper() for the description of parameters.
    … …  
    545544 * Output the action buttons inside the requests loop of the group's manage screen.
    546545 *
    547  * @since 1.0.0
     546 * @since 3.0.0
    548547 *
    549548 * @param array $args Optional. See bp_nouveau_wrapper() for the description of parameters.
    … …  
    577576 * Output the action buttons inside the manage members loop of the group's manage screen.
    578577 *
    579  * @since 1.0.0
     578 * @since 3.0.0
    580579 *
    581580 * @param array $args Optional. See bp_nouveau_wrapper() for the description of parameters.
    … …  
    617616     * or the current displayed group.
    618617     *
    619      * @since 1.0.0
     618     * @since 3.0.0
    620619     *
    621620     * @param array $args Optional. See bp_nouveau_wrapper() for the description of parameters.
    … …  
    977976         * Filter to add your buttons, use the position argument to choose where to insert it.
    978977         *
    979          * @since 1.0.0
     978         * @since 3.0.0
    980979         *
    981980         * @param array  $buttons The list of buttons.
    982981         * @param int    $group   The current group object.
    983          * @parem string $type    Whether we're displaying a groups loop or a groups single item.
     982         * @param string $type    Whether we're displaying a groups loop or a groups single item.
    984983         */
    985984        $buttons_group = apply_filters( 'bp_nouveau_get_groups_buttons', $buttons, $group, $type );
    … …  
    10181017         * Leave a chance to adjust the $return
    10191018         *
    1020          * @since 1.0.0
     1019         * @since 3.0.0
    10211020         *
    10221021         * @param array  $return  The list of buttons.
    … …  
    10321031 * Does the group has meta.
    10331032 *
    1034  * @since 1.0.0
     1033 * @since 3.0.0
    10351034 *
    10361035 * @return bool True if the group has meta. False otherwise.
    … …  
    10431042 * Does the group have extra meta?
    10441043 *
    1045  * @since 1.0.0
     1044 * @since 3.0.0
    10461045 *
    10471046 * @return bool True if the group has meta. False otherwise.
    … …  
    10541053 * Display the group meta.
    10551054 *
    1056  * @since 1.0.0
     1055 * @since 3.0.0
    10571056 *
    10581057 * @return string HTML Output.
    … …  
    10791078     * Get the group meta.
    10801079     *
    1081      * @since 1.0.0
     1080     * @since 3.0.0
    10821081     *
    10831082     * @return array The group meta.
    … …  
    11271126             * Filter to add/remove Group meta.
    11281127             *
    1129              * @since 1.0.0
     1128             * @since 3.0.0
    11301129             *
    11311130             * @param array  $meta     The list of meta to output.
    … …  
    11421141 * Load the appropriate content for the single group pages
    11431142 *
    1144  * @since 1.0.0
     1143 * @since 3.0.0
    11451144 */
    11461145function bp_nouveau_group_template_part() {
    … …  
    12191218 * Use the appropriate Group header and enjoy a template hierarchy
    12201219 *
    1221  * @since 1.0.0
     1220 * @since 3.0.0
    12221221 */
    12231222function bp_nouveau_group_header_template_part() {
    … …  
    12521251 * reach the Customizer section where it's possible to do it.
    12531252 *
    1254  * @since 1.0.0
     1253 * @since 3.0.0
    12551254 *
    12561255 * @return string HTML Output
    … …  
    12701269 * reach the Customizer section where it's possible to do it.
    12711270 *
    1272  * @since 1.0.0
     1271 * @since 3.0.0
    12731272 *
    12741273 * @return string HTML Output
    … …  
    12871286 * Output the group description excerpt
    12881287 *
    1289  * @since 1.0.0
     1288 * @since 3.0.0
    12901289 *
    12911290 * @param object $group  Optional. The group being referenced.
    … …  
    13061305 * Checks if the group loop is set as a 'Grid' layout and returns a reduced excerpt.
    13071306 *
    1308  * @since 1.0.0
     1307 * @since 3.0.0
    13091308 *
    13101309 * @param object $group  Optional. The group being referenced.
    … …  
    13391338     * Filters the excerpt of a group description.
    13401339     *
    1341      * @since 1.0.0
     1340     * @since 3.0.0
    13421341     *
    13431342     * @param string $value Excerpt of a group description.
Note: See TracChangeset for help on using the changeset viewer.