Changeset 7558 for trunk/bp-friends/bp-friends-loader.php

Timestamp:

11/11/2013 12:52:44 AM (12 years ago)

Author:

boonebgorges

Message:

Improve inline docs in bp-friends component. See #5022

File:

• trunk/bp-friends/bp-friends-loader.php (modified) (8 diffs)

trunk/bp-friends/bp-friends-loader.php

@@ -3 +3 @@
  * BuddyPress Friends Streams Loader
  *
- * The friends component is for users to create relationships with each other
+ * The friends component is for users to create relationships with each other.
  *
  * @package BuddyPress
- * @subpackage Friends Core
+ * @subpackage Friends
  */
 
@@ -15 +15 @@
 
     /**
-     * Start the friends component creation process
-     *
-     * @since BuddyPress (1.5)
+     * Start the friends component creation process.
+     *
+     * @since BuddyPress (1.5.0)
      */
     function __construct() {
@@ -31 +31 @@
 
     /**
-     * Include files
+     * Include bp-friends files.
+     *
+     * @see BP_Component::includes() for description of parameters.
+     *
+     * @param array $includes See {@link BP_Component::includes()}.
      */
     public function includes( $includes = array() ) {
@@ -50 +54 @@
 
     /**
-     * Setup globals
+     * Set up bp-friends global settings.
      *
      * The BP_FRIENDS_SLUG constant is deprecated, and only used here for
      * backwards compatibility.
      *
-     * @since BuddyPress (1.5)
+     * @since BuddyPress (1.5.0)
+     *
+     * @see BP_Component::setup_globals() for description of parameters.
+     *
+     * @param array $args See {@link BP_Component::setup_globals()}.
      */
     public function setup_globals( $args = array() ) {
@@ -90 +98 @@
 
     /**
-     * Setup BuddyBar navigation
+     * Set up component navigation.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @see BP_Component::setup_nav() for a description of arguments.
+     *
+     * @param array $main_nav Optional. See BP_Component::setup_nav() for
+     *        description.
+     * @param array $sub_nav Optional. See BP_Component::setup_nav() for
+     *        description.
      */
     public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
@@ -141 +158 @@
 
     /**
-     * Set up the Toolbar
+     * Set up bp-friends integration with the WordPress admin bar.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @see BP_Component::setup_admin_bar() for a description of arguments.
+     *
+     * @param array $wp_admin_nav See BP_Component::setup_admin_bar()
+     *        for description.
      */
     public function setup_admin_bar( $wp_admin_nav = array() ) {
@@ -192 +216 @@
 
     /**
-     * Sets up the title for pages and <title>
+     * Set up the title for pages and <title>.
      */
     function setup_title() {
@@ -215 +239 @@
 }
 
+/**
+ * Set up the bp-forums component.
+ */
 function bp_setup_friends() {
     buddypress()->friends = new BP_Friends_Component();