Changeset 10012 for trunk/src/bp-core/bp-core-template.php

Timestamp:

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

Author:

tw2113

Message:

First pass at BP-Core docs cleanup.

See #6398.

File:

• trunk/src/bp-core/bp-core-template.php (modified) (13 diffs)

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

@@ -26 +26 @@
  * @uses bp_get_user_nav() Renders the navigation for a profile of a currently
  *       viewed user.
+ *
+ * @param string $parent_slug
+ *
+ * @return string
  */
 function bp_get_options_nav( $parent_slug = '' ) {
@@ -111 +115 @@
  * @since BuddyPress (2.0.0)
  *
+ * @param string $component
+ *
  * @return string
  */
@@ -335 +341 @@
  * @since BuddyPress (1.1.0)
  *
- * @param int  $time         The UNIX timestamp to be formatted.
+ * @param int|string  $time         The UNIX timestamp to be formatted.
  * @param bool $exclude_time Optional. True to return only the month + day, false
  *                           to return month, day, and time. Default: false.
@@ -702 +708 @@
  * @see bp_get_button()
  *
- * @param array $args See {@link BP_Button}.
+ * @param array|string $args See {@link BP_Button}.
  */
 function bp_button( $args = '' ) {
@@ -712 +718 @@
      * @see BP_Button for a description of arguments and return value.
      *
-     * @param array $args See {@link BP_Button}.
+     * @param array|string $args See {@link BP_Button}.
      * @return string HTML markup for the button.
      */
@@ -1108 +1114 @@
  * WordPress theme without coping the functions from functions.php.
  *
- * @param string $object
+ * @param string|bool $object
  * @return string The AJAX querystring.
  */
@@ -1178 +1184 @@
  * Return the name of the current item.
  *
- * @return unknown
+ * @return string|bool
  */
 function bp_current_item() {
@@ -1423 +1429 @@
          * @since BuddyPress (1.5.0)
          *
-         * @param string BP_SEARCH_SLUG The search slug. Default "search".
+         * @const string BP_SEARCH_SLUG The search slug. Default "search".
          */
         return apply_filters( 'bp_get_search_slug', BP_SEARCH_SLUG );
@@ -1597 +1603 @@
  *
  * @param string $action_variable The action_variable being tested against.
- * @param int $position Optional. The array key you're testing against. If you
+ * @param int|bool $position Optional. The array key you're testing against. If you
  *        don't provide a $position, the function will return true if the
  *        $action_variable is found *anywhere* in the action variables array.
@@ -1755 +1761 @@
  * already deprecated functions.
  *
+ * @param string $component_name
+ *
  * @return bool True if root component, else false.
  */
@@ -1793 +1801 @@
  * @since BuddyPress (1.5.0)
  *
- * @global $current_blog WordPress global for the current blog.
+ * @global int $current_blog WordPress global for the current blog.
  *
  * @param string $component Optional. Name of the component to check for.
@@ -2692 +2700 @@
  * Not currently used by BuddyPress.
  *
+ * @param string $component Current component to check for.
+ * @param string $callback  Callback to invoke.
+ *
  * @return bool
  */
@@ -2724 +2735 @@
 /**
  * Customize the body class, according to the currently displayed BP content.
- *
- * Uses the above is_() functions to output a body class for each scenario.
- *
- * @param array $wp_classes The body classes coming from WP.
- * @param array $custom_classes Classes that were passed to get_body_class().
- * @return array $classes The BP-adjusted body classes.
  */
 function bp_the_body_class() {
     echo bp_get_the_body_class();
 }
+    /**
+     * Customize the body class, according to the currently displayed BP content.
+     *
+     * Uses the above is_() functions to output a body class for each scenario.
+     *
+     * @param array $wp_classes The body classes coming from WP.
+     * @param array|bool $custom_classes Classes that were passed to get_body_class().
+     * @return array $classes The BP-adjusted body classes.
+     */
     function bp_get_the_body_class( $wp_classes = array(), $custom_classes = false ) {