Skip to:
Content

bbPress.org


Ignore:
Timestamp:
10/28/2015 04:07:50 AM (10 years ago)
Author:
netweb
Message:

Standardize @since PHPDoc tags style and format

This changeset updates the style and formatting of all of our @since instances for compatibility with phpDocumentor 2 and WP-Parser as we move toward implementing the bbPress developer code reference.

Props thebrandonallen
Fixes #2879

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/includes/extend/buddypress/groups.php

    r5908 r5951  
    1919 * Loads Group Extension for Forums Component
    2020 *
    21  * @since bbPress (r3552)
     21 * @since 2.1.0 bbPress (r3552)
    2222 *
    2323 * @package bbPress
     
    3131     * Setup bbPress group extension variables
    3232     *
    33      * @since bbPress (r3552)
     33     * @since 2.1.0 bbPress (r3552)
    3434     */
    3535    public function __construct() {
     
    4343     * Setup the group forums class variables
    4444     *
    45      * @since bbPress (r3552)
     45     * @since 2.1.0 bbPress (r3552)
    4646     */
    4747    private function setup_variables() {
     
    7676     * Setup the group forums class actions
    7777     *
    78      * @since bbPress (r4552)
     78     * @since 2.3.0 bbPress (r4552)
    7979     */
    8080    private function setup_actions() {
     
    105105     * Setup the group forums class filters
    106106     *
    107      * @since bbPress (r4552)
     107     * @since 2.3.0 bbPress (r4552)
    108108     */
    109109    private function setup_filters() {
     
    150150     * The primary display function for group forums
    151151     *
    152      * @since bbPress (r3746)
     152     * @since 2.1.0 bbPress (r3746)
    153153     *
    154154     * @param int $group_id ID of the current group. Available only on BP 2.2+.
     
    175175     * Maybe unset the group forum nav item if group does not have a forum
    176176     *
    177      * @since bbPress (r4552)
     177     * @since 2.3.0 bbPress (r4552)
    178178     *
    179179     * @return If not viewing a single group
     
    196196     * Allow group members to have advanced priviledges in group forum topics.
    197197     *
    198      * @since bbPress (r4434)
     198     * @since 2.2.0 bbPress (r4434)
    199199     *
    200200     * @param array $caps
     
    246246     * Remove the topic meta cap map, so it doesn't interfere with sidebars.
    247247     *
    248      * @since bbPress (r4434)
     248     * @since 2.2.0 bbPress (r4434)
    249249     */
    250250    public function remove_group_forum_meta_cap_map() {
     
    257257     * Show forums and new forum form when editing a group
    258258     *
    259      * @since bbPress (r3563)
     259     * @since 2.1.0 bbPress (r3563)
    260260     *
    261261     * @param object $group (the group to edit if in Group Admin UI)
     
    323323     * Save the Group Forum data on edit
    324324     *
    325      * @since bbPress (r3465)
     325     * @since 2.0.0 bbPress (r3465)
    326326     *
    327327     * @param int $group_id (to handle Group Admin UI hook bp_group_admin_edit_after )
     
    434434     * Adds a metabox to BuddyPress Group Admin UI
    435435     *
    436      * @since bbPress (r4814)
     436     * @since 2.3.0 bbPress (r4814)
    437437     *
    438438     * @uses add_meta_box
     
    453453     * Displays the bbPress metabox in BuddyPress Group Admin UI
    454454     *
    455      * @since bbPress (r4814)
     455     * @since 2.3.0 bbPress (r4814)
    456456     *
    457457     * @param object $item (group object)
     
    468468     * Show forums and new forum form when creating a group
    469469     *
    470      * @since bbPress (r3465)
     470     * @since 2.0.0 bbPress (r3465)
    471471     */
    472472    public function create_screen( $group_id = 0 ) {
     
    498498     * Save the Group Forum data on create
    499499     *
    500      * @since bbPress (r3465)
     500     * @since 2.0.0 bbPress (r3465)
    501501     */
    502502    public function create_screen_save( $group_id = 0 ) {
     
    585585     * Used to start an output buffer
    586586     *
    587      * @since bbPress (r3746)
     587     * @since 2.1.0 bbPress (r3746)
    588588     */
    589589    public function ob_start() {
     
    594594     * Used to end an output buffer
    595595     *
    596      * @since bbPress (r3746)
     596     * @since 2.1.0 bbPress (r3746)
    597597     */
    598598    public function ob_end_clean() {
     
    603603     * Creating a group forum or category (including root for group)
    604604     *
    605      * @since bbPress (r3653)
     605     * @since 2.1.0 bbPress (r3653)
    606606     *
    607607     * @param type $forum_args
     
    630630     * Removing a group forum or category (including root for group)
    631631     *
    632      * @since bbPress (r3653)
     632     * @since 2.1.0 bbPress (r3653)
    633633     *
    634634     * @param type $forum_args
     
    657657     * Listening to BuddyPress Group deletion to remove the forum
    658658     *
    659      * @since bbPress (r4815)
     659     * @since 2.3.0 bbPress (r4815)
    660660     *
    661661     * @param int $group_id The group ID
     
    736736     * Toggle the enable_forum group setting on or off
    737737     *
    738      * @since bbPress (r4612)
     738     * @since 2.3.0 bbPress (r4612)
    739739     *
    740740     * @param int $group_id The group to toggle
     
    779779     * In the future, many-to-many should be allowed.
    780780     *
    781      * @since bbPress (r3653)
     781     * @since 2.1.0 bbPress (r3653)
    782782     *
    783783     * @uses bp_get_current_group_id()
     
    978978     * Strip super stickies from the topic query
    979979     *
    980      * @since bbPress (r4810)
     980     * @since 2.3.0 bbPress (r4810)
    981981     *
    982982     * @access private
     
    992992     * Unset the type super sticky from topic type
    993993     *
    994      * @since bbPress (r4810)
     994     * @since 2.3.0 bbPress (r4810)
    995995     *
    996996     * @access private
     
    10081008     * Ugly preg_replace to hide the to front admin link
    10091009     *
    1010      * @since bbPress (r4810)
     1010     * @since 2.3.0 bbPress (r4810)
    10111011     *
    10121012     * @access private
     
    10281028     * Redirect to the group forum screen
    10291029     *
    1030      * @since bbPress (r3653)
     1030     * @since 2.1.0 bbPress (r3653)
    10311031     *
    10321032     * @param str $redirect_url
     
    10461046     * Redirect to the group forum screen
    10471047     *
    1048      * @since bbPress (r3653)
     1048     * @since 2.1.0 bbPress (r3653)
    10491049     */
    10501050    public function new_reply_redirect_to( $redirect_url = '', $redirect_to = '', $reply_id = 0 ) {
     
    10791079     * Redirect to the group admin forum edit screen
    10801080     *
    1081      * @since bbPress (r3653)
     1081     * @since 2.1.0 bbPress (r3653)
    10821082     *
    10831083     * @uses groups_get_current_group()
     
    11051105     * Prevent Forum Parent from appearing
    11061106     *
    1107      * @since bbPress (r3746)
     1107     * @since 2.1.0 bbPress (r3746)
    11081108     */
    11091109
     
    11191119     * Prevent Topic Parent from appearing
    11201120     *
    1121      * @since bbPress (r3746)
     1121     * @since 2.1.0 bbPress (r3746)
    11221122     *
    11231123     * @uses bbp_get_group_forum_ids() to get BuddyPress group forums
     
    11401140     * Permissions to view the 'New Topic'/'Reply To' form in a BuddyPress group.
    11411141     *
    1142      * @since bbPress (r4608)
     1142     * @since 2.3.0 bbPress (r4608)
    11431143     *
    11441144     * @param bool $retval Are we allowed to view the reply form?
     
    11851185     * we need to let BP know that bbPress added a forum.
    11861186     *
    1187      * @since bbPress (r5026)
     1187     * @since 2.4.0 bbPress (r5026)
    11881188     *
    11891189     * @link https://bbpress.trac.wordpress.org/ticket/2339/
     
    12071207     * Maybe map a bbPress forum/topic/reply permalink to the corresponding group
    12081208     *
    1209      * @since bbPress (r4266)
     1209     * @since 2.2.0 bbPress (r4266)
    12101210     *
    12111211     * @param int $post_id
     
    12781278     * Map a forum permalink to its corresponding group
    12791279     *
    1280      * @since bbPress (r3802)
     1280     * @since 2.1.0 bbPress (r3802)
    12811281     *
    12821282     * @param string $url
     
    12921292     * Map a topic permalink to its group forum
    12931293     *
    1294      * @since bbPress (r3802)
     1294     * @since 2.1.0 bbPress (r3802)
    12951295     *
    12961296     * @param string $url
     
    13061306     * Map a reply permalink to its group forum
    13071307     *
    1308      * @since bbPress (r3802)
     1308     * @since 2.1.0 bbPress (r3802)
    13091309     *
    13101310     * @param string $url
     
    13201320     * Map a reply edit link to its group forum
    13211321     *
    1322      * @since bbPress (r4266)
     1322     * @since 2.2.0 bbPress (r4266)
    13231323     *
    13241324     * @param string $url
     
    13401340     * Map a post link to its group forum
    13411341     *
    1342      * @since bbPress (r4266)
     1342     * @since 2.2.0 bbPress (r4266)
    13431343     *
    13441344     * @param string $url
     
    13551355     * Map a page link to its group forum
    13561356     *
    1357      * @since bbPress (r4266)
     1357     * @since 2.2.0 bbPress (r4266)
    13581358     *
    13591359     * @param string $url
     
    13701370     * Map a custom post type link to its group forum
    13711371     *
    1372      * @since bbPress (r4266)
     1372     * @since 2.2.0 bbPress (r4266)
    13731373     *
    13741374     * @param string $url
     
    13861386     * Fix pagination of topics on forum view
    13871387     *
    1388      * @since bbPress (r4266)
     1388     * @since 2.2.0 bbPress (r4266)
    13891389     *
    13901390     * @param array $args
     
    14081408     * Fix pagination of replies on topic view
    14091409     *
    1410      * @since bbPress (r4266)
     1410     * @since 2.2.0 bbPress (r4266)
    14111411     *
    14121412     * @param array $args
     
    14301430     * viewed via the group URL.
    14311431     *
    1432      * @since bbPress (r3802)
     1432     * @since 2.1.0 bbPress (r3802)
    14331433     */
    14341434    public function redirect_canonical() {
     
    14751475     * Map a forum post to its corresponding group in the group activity stream.
    14761476     *
    1477      * @since bbPress (r4396)
     1477     * @since 2.2.0 bbPress (r4396)
    14781478     *
    14791479     * @param array $args Arguments from BBP_BuddyPress_Activity::record_activity()
Note: See TracChangeset for help on using the changeset viewer.