Changeset 10012 for trunk/src/bp-core/admin/bp-core-admin-schema.php

Timestamp:

07/12/2015 12:49:36 AM (11 years ago)

Author:

tw2113

Message:

First pass at BP-Core docs cleanup.

See #6398.

File:

• trunk/src/bp-core/admin/bp-core-admin-schema.php (modified) (12 diffs)

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

@@ -2 +2 @@
 
 /**
- * BuddyPress DB schema
+ * BuddyPress DB schema.
  *
  * @package BuddyPress
@@ -12 +12 @@
 
 /**
- * Get the DB schema to use for BuddyPress components
+ * Get the DB schema to use for BuddyPress components.
  *
  * @since BuddyPress (1.1.0)
  *
  * @global $wpdb $wpdb
- * @return string The default database character-set, if set
+ * @return string The default database character-set, if set.
  */
 function bp_core_set_charset() {
@@ -28 +28 @@
 
 /**
- * Main installer
+ * Main installer.
  *
  * Can be passed an optional array of components to explicitly run installation
@@ -35 +35 @@
  * @since BuddyPress (1.0.0)
  *
- * @param array $active_components Components to install
+ * @param array|bool $active_components Components to install.
  */
 function bp_core_install( $active_components = false ) {
@@ -86 +86 @@
 
 /**
- * Install database tables for the Notifications component
+ * Install database tables for the Notifications component.
  *
  * @since BuddyPress (1.0.0)
@@ -130 +130 @@
 
 /**
- * Install database tables for the Activity component
+ * Install database tables for the Activity component.
  *
  * @since BuddyPress (1.0.0)
@@ -183 +183 @@
 
 /**
- * Install database tables for the Notifications component
+ * Install database tables for the Notifications component.
  *
  * @since BuddyPress (1.0.0)
@@ -211 +211 @@
 
 /**
- * Install database tables for the Groups component
+ * Install database tables for the Groups component.
  *
  * @since BuddyPress (1.0.0)
@@ -271 +271 @@
 
 /**
- * Install database tables for the Messages component
+ * Install database tables for the Messages component.
  *
  * @since BuddyPress (1.0.0)
@@ -331 +331 @@
 
 /**
- * Install database tables for the Profiles component
+ * Install database tables for the Profiles component.
  *
  * @since BuddyPress (1.0.0)
@@ -421 +421 @@
 
 /**
- * Install database tables for the Sites component
+ * Install database tables for the Sites component.
  *
  * @since BuddyPress (1.0.0)
@@ -501 +501 @@
  * This is necessary because WordPress's `pre_schema_upgrade()` function wraps
  * table ALTER's in multisite checks, and other plugins may have installed their
- * own sign-ups table; Eg: Gravity Forms User Registration Add On
+ * own sign-ups table; Eg: Gravity Forms User Registration Add On.
  *
  * @since BuddyPress (2.0.1)