Changeset 3746

Timestamp:

01/19/2011 03:01:32 PM (16 years ago)

Author:

boonebgorges

Message:

Adds PHPDoc to functions in bp-core-admin.php

File:

• trunk/bp-core/admin/bp-core-admin.php (modified) (5 diffs)

trunk/bp-core/admin/bp-core-admin.php

@@ -1 +1 @@
 <?php
 
+/**
+ * Renders the main admin panel.
+ *
+ * @package BuddyPress Core
+ * @since {@internal Unknown}}
+ */
 function bp_core_admin_dashboard() { ?>
         <div class="wrap" id="bp-admin">
@@ -22 +28 @@
 }
 
+/**
+ * Renders the Settings admin panel.
+ *
+ * @package BuddyPress Core
+ * @since {@internal Unknown}}
+ */
 function bp_core_admin_settings() {
         global $wpdb, $bp, $current_blog;
@@ -153 +165 @@
 }
 
+/**
+ * Renders the Component Setup admin panel.
+ *
+ * @package BuddyPress Core
+ * @since {@internal Unknown}}
+ * @uses bp_core_admin_component_options()
+ */
 function bp_core_admin_component_setup() {
         global $wpdb, $bp;
@@ -200 +219 @@
 }
 
+/**
+ * Creates reusable markup for the component setup dashboard panel.
+ *
+ * This markup has been abstracted so that it can be used both during the setup wizard as well as
+ * when BP has been fully installed.
+ *
+ * @package BuddyPress Core
+ * @since 1.3
+ */
 function bp_core_admin_component_options() {
         $disabled_components = apply_filters( 'bp_deactivated_components', get_site_option( 'bp-deactivated-components' ) ); 
@@ -299 +327 @@
 }
 
+/**
+ * Loads admin panel styles and scripts.
+ *
+ * @package BuddyPress Core
+ * @since {@internal Unknown}}
+ */
 function bp_core_add_admin_menu_styles() {
         if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG )