Changeset 8482 for trunk/src/bp-messages/bp-messages-screens.php

Timestamp:

06/08/2014 09:12:34 PM (12 years ago)

Author:

boonebgorges

Message:

Improved inline documentation in the Messages component.

See #5022

File:

• trunk/src/bp-messages/bp-messages-screens.php (modified) (7 diffs)

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

@@ -4 +4 @@
  * BuddyPress Messages Screens
  *
- * Screen functions are the controllers of BuddyPress. They will execute when their
- * specific URL is caught. They will first save or manipulate data using business
- * functions, then pass on the user to a template file.
+ * Screen functions are the controllers of BuddyPress. They will execute when
+ * their specific URL is caught. They will first save or manipulate data using
+ * business functions, then pass on the user to a template file.
  *
  * @package BuddyPress
@@ -15 +15 @@
 if ( !defined( 'ABSPATH' ) ) exit;
 
+/**
+ * Load the Messages > Inbox screen.
+ */
 function messages_screen_inbox() {
         if ( bp_action_variables() ) {
@@ -25 +28 @@
 }
 
+/**
+ * Load the Messages > Sent screen.
+ */
 function messages_screen_sentbox() {
         if ( bp_action_variables() ) {
@@ -35 +41 @@
 }
 
+/**
+ * Load the Messages > Compose screen.
+ */
 function messages_screen_compose() {
         global $bp;
@@ -87 +96 @@
 }
 
+/**
+ * Load an individual conversation screen.
+ *
+ * @return bool|null False on failure.
+ */
 function messages_screen_conversation() {
 
@@ -110 +124 @@
 add_action( 'bp_screens', 'messages_screen_conversation' );
 
+/**
+ * Load the Messages > Notices screen.
+ *
+ * @return false|null False on failure.
+ */
 function messages_screen_notices() {
         global $notice_id;
@@ -153 +172 @@
 }
 
+/**
+ * Render the markup for the Messages section of Settings > Notifications.
+ */
 function messages_screen_notification_settings() {
         if ( bp_action_variables() ) {