Changeset 7554 for trunk/bp-forums/bp-forums-loader.php

Timestamp:

11/10/2013 02:04:10 AM (11 years ago)

Author:

boonebgorges

Message:

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

File:

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

trunk/bp-forums/bp-forums-loader.php

@@ -6 +6 @@
  * A discussion forums component. Comes bundled with bbPress stand-alone.
  *
+ * Note: The bp-forums component has been retired. Use the bbPress WordPress
+ * plugin instead.
+ *
  * @package BuddyPress
- * @subpackage Forums Core
+ * @subpackage Forums
  */
 
@@ -16 +19 @@
 
     /**
-     * Start the forums component creation process
-     *
-     * @since BuddyPress (1.5)
+     * Start the forums component creation process.
+     *
+     * @since BuddyPress (1.5.0)
      */
     function __construct() {
@@ -32 +35 @@
 
     /**
-     * Setup globals
+     * Set up bp-forums global settings.
      *
      * The BP_FORUMS_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() ) {
@@ -68 +75 @@
 
     /**
-     * Include files
+     * Include bp-forums files.
+     *
+     * @see BP_Component::includes() for description of parameters.
+     *
+     * @param array $includes See {@link BP_Component::includes()}.
      */
     public function includes( $includes = array() ) {
@@ -96 +107 @@
 
     /**
-     * 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() ) {
@@ -156 +176 @@
 
     /**
-     * Set up the Toolbar
+     * Set up bp-forums 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() ) {
@@ -203 +230 @@
 
     /**
-     * Sets up the title for pages and <title>
+     * Set up the title for pages and the <title> element.
      */
     function setup_title() {
@@ -226 +253 @@
 }
 
+/**
+ * Set up the bp-forums component.
+ */
 function bp_setup_forums() {
     buddypress()->forums = new BP_Forums_Component();