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

Timestamp:

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

Author:

boonebgorges

Message:

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

File:

• trunk/bp-forums/bp-forums-screens.php (modified) (11 diffs)

trunk/bp-forums/bp-forums-screens.php

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress Forums Screen Functions
+ * BuddyPress Forums Screen Functions.
  *
  * @package BuddyPress
@@ -10 +10 @@
 if ( !defined( 'ABSPATH' ) ) exit;
 
+/**
+ * Load the Forums directory.
+ */
 function bp_forums_directory_forums_setup() {
 
@@ -80 +83 @@
 add_action( 'bp_screens', 'bp_forums_directory_forums_setup', 2 );
 
+/**
+ * Load the Topics Started screen.
+ */
 function bp_member_forums_screen_topics() {
     do_action( 'bp_member_forums_screen_topics' );
@@ -86 +92 @@
 }
 
+/**
+ * Load the Replied To screen.
+ */
 function bp_member_forums_screen_replies() {
     do_action( 'bp_member_forums_screen_replies' );
@@ -93 +102 @@
 
 /**
- * Loads the template content for a user's Favorites forum tab.
+ * Load the template content for a user's Favorites forum tab.
  *
  * Note that this feature is not fully implemented at the moment.
- *
- * @package BuddyPress Forums
  */
 function bp_member_forums_screen_favorites() {
@@ -105 +112 @@
 }
 
+/**
+ * Load a single forum page.
+ */
 function bp_forums_screen_single_forum() {
 
@@ -116 +126 @@
 add_action( 'bp_screens', 'bp_forums_screen_single_forum' );
 
+/**
+ * Load a single forum topic page.
+ */
 function bp_forums_screen_single_topic() {
 
@@ -131 +144 @@
 
 /**
- * The main theme compat class for legacy BuddyPress forums, as powered by bbPress 1.x
+ * The main theme compat class for legacy BuddyPress forums.
  *
  * This class sets up the necessary theme compatability actions to safely output
  * old forum template parts to the_title and the_content areas of a theme.
  *
- * @since BuddyPress (1.7)
+ * @since BuddyPress (1.7.0)
  */
 class BP_Forum_Legacy_Theme_Compat {
 
     /**
-     * Setup the old forums component theme compatibility
-     *
-     * @since BuddyPress (1.7)
+     * Set up theme compatibility for the legacy forums component.
+     *
+     * @since BuddyPress (1.7.0)
      */
     public function __construct() {
@@ -152 +165 @@
      * Are we looking at something that needs old forum theme compatability?
      *
-     * @since BuddyPress (1.7)
+     * @since BuddyPress (1.7.0)
      */
     public function is_legacy_forum() {
@@ -185 +198 @@
 
     /**
-     * Update the global $post with directory data
-     *
-     * @since BuddyPress (1.7)
+     * Update the global $post with directory data.
+     *
+     * @since BuddyPress (1.7.0)
      */
     public function directory_dummy_post() {
@@ -212 +225 @@
 
     /**
-     * Filter the_content with the old forum index template part
-     *
-     * @since BuddyPress (1.7)
+     * Filter the_content with the old forum index template part.
+     *
+     * @since BuddyPress (1.7.0)
      */
     public function directory_content() {