Changeset 10356 for trunk/src/bp-core/bp-core-dependency.php

Timestamp:

11/15/2015 07:57:03 PM (10 years ago)

Author:

tw2113

Message:

[Samus Aran]
I first battled the documentation inconsistencies on planet Zebes. It was there that I foiled the plans of the
Space Pirate leader Mother Brain to use the issues to attack galactic civilization...

I next fought the inconsistencies on their homeworld SR388. I completely eradicated them except for an @since tag,
which after hatching followed me like a confused child...

I personally delivered it to the Galactic Research Station at Ceres so scientists could study its energy production qualities...

The scientists' findings were astounding! They discovered that the powers of the docs inconsistencies
might be harnessed for the good of galactic civilization!

Satisfied that all was well, I left the station to seek a new bounty to hunt. But, I had hardly gone beyond the asteroid
belt when I picked up a distress signal!

Ceres station was under attack!

More documentation cleanup for part of BP-Core component.

See #6398.

File:

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

trunk/src/bp-core/bp-core-dependency.php

@@ -490 +490 @@
  *
  * @param array $query_vars See {@link WP::parse_request()}.
- *
  * @return array $query_vars See {@link WP::parse_request()}.
  */
@@ -512 +511 @@
  * @param string $redirect_to     See 'login_redirect'.
  * @param string $redirect_to_raw See 'login_redirect'.
- *
- * @param bool   $user See 'login_redirect'.
- *
+ * @param bool   $user            See 'login_redirect'.
  * @return string
  */
@@ -541 +538 @@
  *
  * @param string $template See 'template_include'.
- *
  * @return string Template file to use.
  */
@@ -586 +582 @@
  * @uses apply_filters() Calls 'bp_allowed_themes' with the allowed themes list.
  *
- * @param array $themes
- *
+ * @param array $themes The path of the template to include.
  * @return array
  */
@@ -608 +603 @@
  *
  * @since 1.9.0
+ *
  * @uses do_action()
  */
 function bp_post_request() {
 
-    // Bail if not a POST action
+    // Bail if not a POST action.
     if ( ! bp_is_post_request() ) {
         return;
     }
 
-    // Bail if no action
+    // Bail if no action.
     if ( empty( $_POST['action'] ) ) {
         return;
     }
 
-    // Sanitize the POST action
+    // Sanitize the POST action.
     $action = sanitize_key( $_POST['action'] );
 
@@ -651 +647 @@
  *
  * @since 1.9.0
+ *
  * @uses do_action()
  */
 function bp_get_request() {
 
-    // Bail if not a POST action
+    // Bail if not a POST action.
     if ( ! bp_is_get_request() ) {
         return;
     }
 
-    // Bail if no action
+    // Bail if no action.
     if ( empty( $_GET['action'] ) ) {
         return;
     }
 
-    // Sanitize the GET action
+    // Sanitize the GET action.
     $action = sanitize_key( $_GET['action'] );