Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
08/18/2012 10:15:09 AM (14 years ago)
Author:
djpaul
Message:

Update @since phpdoc on functions to use our formatted version of the tag, e.g. "@since BuddyPress (1.6)". Fixes #4445, props fanquake

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/bp-activity/bp-activity-admin.php

    r6193 r6259  
    77 *
    88 * @package BuddyPress
    9  * @since 1.6
     9 * @since BuddyPress (1.6)
    1010 * @subpackage Activity
    1111 */
    … …  
    2424 * Registers the Activity component admin screen
    2525 *
    26  * @since 1.6
     26 * @since BuddyPress (1.6)
    2727 */
    2828function bp_activity_add_admin_menu() {
    … …  
    4343 * comment, and returns HTML for a new table row.
    4444 *
    45  * @since 1.6
     45 * @since BuddyPress (1.6)
    4646 */
    4747function bp_activity_admin_reply() {
    … …  
    117117 * @param string $new_value Screen option form value
    118118 * @return string Option value. False to abandon update.
    119  * @since 1.6
     119 * @since BuddyPress (1.6)
    120120 */
    121121function bp_activity_admin_screen_options( $value, $option, $new_value ) {
    … …  
    136136 * @param WP_Screen $screen Screen identifier
    137137 * @return array Hidden Meta Boxes
    138  * @since 1.0
     138 * @since BuddyPress (1.0)
    139139 */
    140140function bp_activity_admin_edit_hidden_metaboxes( $hidden, $screen ) {
    … …  
    154154 * @global object $bp BuddyPress global settings
    155155 * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table
    156  * @since 1.6
     156 * @since BuddyPress (1.6)
    157157 */
    158158function bp_activity_admin_load() {
    … …  
    504504 * Outputs the Activity component admin screens
    505505 *
    506  * @since 1.6
     506 * @since BuddyPress (1.6)
    507507 */
    508508function bp_activity_admin() {
    … …  
    523523 *
    524524 * @global int $screen_layout_columns Number of columns shown on this admin page
    525  * @since 1.6
     525 * @since BuddyPress (1.6)
    526526 */
    527527function bp_activity_admin_edit() {
    … …  
    617617 *
    618618 * @param object $item Activity item
    619  * @since 1.6
     619 * @since BuddyPress (1.6)
    620620 */
    621621function bp_activity_admin_edit_metabox_status( $item ) {
    … …  
    672672 *
    673673 * @param object $item Activity item
    674  * @since 1.6
     674 * @since BuddyPress (1.6)
    675675 */
    676676function bp_activity_admin_edit_metabox_link( $item ) {
    … …  
    688688 *
    689689 * @param object $item Activity item
    690  * @since 1.6
     690 * @since BuddyPress (1.6)
    691691 */
    692692function bp_activity_admin_edit_metabox_userid( $item ) {
    … …  
    704704 * @global object $bp BuddyPress global settings
    705705 * @param object $item Activity item
    706  * @since 1.6
     706 * @since BuddyPress (1.6)
    707707 */
    708708function bp_activity_admin_edit_metabox_type( $item ) {
    … …  
    740740 *
    741741 * @param object $item Activity item
    742  * @since 1.6
     742 * @since BuddyPress (1.6)
    743743 */
    744744function bp_activity_admin_edit_metabox_itemids( $item ) {
    … …  
    762762 * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table
    763763 * @global string $plugin_page
    764  * @since 1.6
     764 * @since BuddyPress (1.6)
    765765 */
    766766function bp_activity_admin_index() {
    … …  
    887887 * List table class for the Activity component admin page.
    888888 *
    889  * @since 1.6
     889 * @since BuddyPress (1.6)
    890890 */
    891891class BP_Activity_List_Table extends WP_List_Table {
    … …  
    893893         * What type of view is being displayed? e.g. "All", "Pending", "Approved", "Spam"...
    894894         *
    895          * @since 1.6
     895         * @since BuddyPress (1.6)
    896896        */
    897897        public $view = 'all';
    … …  
    900900         * How many activity items have been marked as spam.
    901901         *
    902          * @since 1.6
     902         * @since BuddyPress (1.6)
    903903         */
    904904        public $spam_count = 0;
    … …  
    907907         * Store activity-to-user-ID mappings for use in the In Response To column.
    908908         *
    909          * @since 1.6
     909         * @since BuddyPress (1.6)
    910910         */
    911911        protected $activity_user_id = array();
    … …  
    914914         * Constructor
    915915         *
    916          * @since 1.6
     916         * @since BuddyPress (1.6)
    917917         */
    918918        public function __construct() {
    … …  
    929929         * Handle filtering of data, sorting, pagination, and any other data-manipulation required prior to rendering.
    930930         *
    931          * @since 1.6
     931         * @since BuddyPress (1.6)
    932932         */
    933933        function prepare_items() {
    … …  
    10311031         *
    10321032         * @return array
    1033          * @since 1.6
     1033         * @since BuddyPress (1.6)
    10341034         */
    10351035        function get_column_info() {
    … …  
    10461046         * Displays a message on screen when no items are found (e.g. no search matches)
    10471047         *
    1048          * @since 1.6
     1048         * @since BuddyPress (1.6)
    10491049         */
    10501050        function no_items() {
    … …  
    10551055         * Outputs the Activity data table
    10561056         *
    1057          * @since 1.6
     1057         * @since BuddyPress (1.6)
    10581058        */
    10591059        function display() {
    … …  
    10891089         *
    10901090         * @param object $item The current item
    1091          * @since 1.6
     1091         * @since BuddyPress (1.6)
    10921092         */
    10931093        function single_row( $item ) {
    … …  
    11031103         * Get the list of views available on this table (e.g. "all", "spam").
    11041104         *
    1105          * @since 1.6
     1105         * @since BuddyPress (1.6)
    11061106         */
    11071107        function get_views() {
    … …  
    11211121         *
    11221122         * @return array Key/value pairs for the bulk actions dropdown
    1123          * @since 1.6
     1123         * @since BuddyPress (1.6)
    11241124         */
    11251125        function get_bulk_actions() {
    … …  
    11371137         * @see WP_List_Table::single_row_columns()
    11381138         * @return array
    1139          * @since 1.6
     1139         * @since BuddyPress (1.6)
    11401140         */
    11411141        function get_columns() {
    … …  
    11521152         *
    11531153         * @return array
    1154          * @since 1.6
     1154         * @since BuddyPress (1.6)
    11551155         * @todo For this to work, BP_Activity_Activity::get() needs updating to supporting ordering by specific fields
    11561156         */
    … …  
    11681168         * @global object $bp BuddyPress global settings
    11691169         * @param string $which 'top' or 'bottom'
    1170          * @since 1.6
     1170         * @since BuddyPress (1.6)
    11711171         */
    11721172        function extra_tablenav( $which ) {
    … …  
    12171217         * @param array $item A singular item (one full row)
    12181218         * @see WP_List_Table::single_row_columns()
    1219          * @since 1.6
     1219         * @since BuddyPress (1.6)
    12201220         */
    12211221        function column_cb( $item ) {
    … …  
    12281228         * @param array $item A singular item (one full row)
    12291229         * @see WP_List_Table::single_row_columns()
    1230          * @since 1.6
     1230         * @since BuddyPress (1.6)
    12311231         */
    12321232        function column_author( $item ) {
    … …  
    12411241         * @param array $item A singular item (one full row)
    12421242         * @see WP_List_Table::single_row_columns()
    1243          * @since 1.6
     1243         * @since BuddyPress (1.6)
    12441244         */
    12451245        function column_comment( $item ) {
    … …  
    13121312         * @param array $item A singular item (one full row)
    13131313         * @see WP_List_Table::single_row_columns()
    1314          * @since 1.6
     1314         * @since BuddyPress (1.6)
    13151315         */
    13161316        function column_response( $item ) {
    … …  
    13401340         *
    13411341         * @param int $activity_id Activity ID to retrieve User ID for
    1342          * @since 1.6
     1342         * @since BuddyPress (1.6)
    13431343         */
    13441344        protected function get_activity_user_id( $activity_id ) {
    … …  
    13741374         * @param array $tree Source array
    13751375         * @return array Flattened array
    1376          * @since 1.6
     1376         * @since BuddyPress (1.6)
    13771377         */
    13781378        public static function flatten_activity_array( $tree ){
Note: See TracChangeset for help on using the changeset viewer.