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

Timestamp:

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

Author:

tw2113

Message:

First pass at BP-Core docs cleanup.

See #6398.

File:

• trunk/src/bp-core/admin/bp-core-admin-components.php (modified) (6 diffs)

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

@@ -2 +2 @@
 
 /**
- * BuddyPress Admin Component Functions
+ * BuddyPress Admin Component Functions.
  *
  * @package BuddyPress
@@ -236 +236 @@
 
 /**
- * Handle saving the Component settings
+ * Handle saving the Component settings.
  *
  * @since BuddyPress (1.6.0)
@@ -278 +278 @@
 
 /**
- * Calculates the components that should be active after save, based on submitted settings
+ * Calculates the components that should be active after save, based on submitted settings.
  *
  * The way that active components must be set after saving your settings must
@@ -299 +299 @@
  * @since BuddyPress (1.7.0)
  *
- * @param array This is the array of component settings coming from the POST
- *   global. You should stripslashes_deep() before passing to this function
+ * @param array $submitted This is the array of component settings coming from the POST
+ *                         global. You should stripslashes_deep() before passing to this function.
+ *
  * @return array The calculated list of component settings
  */
@@ -337 +338 @@
 
 /**
- * Return a list of component information, optionally filtered by type
+ * Return a list of component information, optionally filtered by type.
  *
  * We use this information both to build the markup for the admin screens, as
@@ -344 +345 @@
  * @since BuddyPress (1.7.0)
  *
- * @param string $type 'all', 'optional', 'retired', 'required'
+ * @param string $type 'all', 'optional', 'retired', 'required'.
+ *
  * @return array An array of requested component data
  */