Changeset 8481 for trunk/src/bp-messages/bp-messages-loader.php

Timestamp:

06/07/2014 11:47:51 PM (10 years ago)

Author:

boonebgorges

Message:

Improve inline documentation in bp-messages.

See #5022

File:

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

trunk/src/bp-messages/bp-messages-loader.php

@@ -13 +13 @@
 if ( !defined( 'ABSPATH' ) ) exit;
 
+/**
+ * Implementation of BP_Component for the Messages component.
+ *
+ * @since BuddyPress (1.5.0)
+ */
 class BP_Messages_Component extends BP_Component {
     /**
@@ -24 +29 @@
 
     /**
-     * Start the messages component creation process
-     *
-     * @since BuddyPress (1.5)
+     * Start the messages component creation process.
+     *
+     * @since BuddyPress (1.5.0)
      */
     public function __construct() {
@@ -40 +45 @@
 
     /**
-     * Include files
+     * Include files.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param array $includes See {BP_Component::includes()} for details.
      */
     public function includes( $includes = array() ) {
@@ -62 +71 @@
 
     /**
-     * Setup globals
+     * Set up globals for the Messages component.
      *
      * The BP_MESSAGES_SLUG constant is deprecated, and only used here for
      * backwards compatibility.
      *
-     * @since BuddyPress (1.5)
+     * @since BuddyPress (1.5.0)
+     *
+     * @param array $args Not used.
      */
     public function setup_globals( $args = array() ) {
@@ -99 +110 @@
 
     /**
-     * Setup BuddyBar navigation
+     * Set up navigation for user pages.
+     *
+     * @param array $main_nav See {BP_Component::setup_nav()} for details.
+     * @param array $sub_nav See {BP_Component::setup_nav()} for details.
      */
     public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
@@ -182 +196 @@
 
     /**
-     * Set up the Toolbar
+     * Set up the Toolbar.
+     *
+     * @param array $wp_admin_nav See {BP_Component::setup_admin_bar()}
+     *        for details.
      */
     public function setup_admin_bar( $wp_admin_nav = array() ) {
@@ -251 +268 @@
 
     /**
-     * Sets up the title for pages and <title>
+     * Set up the title for pages and <title>.
      */
     public function setup_title() {
@@ -273 +290 @@
 }
 
+/**
+ * Bootstrap the Messages component.
+ */
 function bp_setup_messages() {
     buddypress()->messages = new BP_Messages_Component();