Changeset 9993 for trunk/src/bp-notifications/bp-notifications-template.php

Timestamp:

07/04/2015 10:17:42 PM (11 years ago)

Author:

tw2113

Message:

Docs cleanup for Notifications component.

See #6404.

File:

• trunk/src/bp-notifications/bp-notifications-template.php (modified) (16 diffs)

trunk/src/bp-notifications/bp-notifications-template.php

@@ -2 +2 @@
 
 /**
- * BuddyPress Notifications Template Functions
+ * BuddyPress Notifications Template Functions.
  *
  * @package BuddyPress
@@ -206 +206 @@
 
         /**
-         * The $_GET argument used in URLs for determining pagination
+         * The $_GET argument used in URLs for determining pagination.
          *
          * @since BuddyPress (1.9.0)
@@ -251 +251 @@
 
         /**
-         * The direction to sort the results (ASC or DESC)
+         * The direction to sort the results (ASC or DESC).
          *
          * @since BuddyPress (1.9.0)
@@ -260 +260 @@
 
         /**
-         * Array of variables used in this notification query
+         * Array of variables used in this notification query.
          *
          * @since BuddyPress (2.2.2)
@@ -434 +434 @@
          *
          * @return bool True if there are more notifications to show,
-         *         otherwise false.
+         *              otherwise false.
          */
         public function notifications() {
@@ -496 +496 @@
  * @since BuddyPress (1.9.0)
  *
- * @param array $args {
+ * @param array|string $args {
  *     Arguments for limiting the contents of the notifications loop. Can be
  *     passed as an associative array, or as a URL query string.
@@ -503 +503 @@
  *     information on the arguments.  In addition, also supports:
  *
- *     @type int $max Optional. Max items to display. Default: false.
+ *     @type int    $max      Optional. Max items to display. Default: false.
  *     @type string $page_arg URL argument to use for pagination.
- *           Default: 'npage'.
+ *                            Default: 'npage'.
  * }
+ *
+ * @return bool
  */
 function bp_has_notifications( $args = '' ) {
@@ -874 +876 @@
 
 /**
- * Output the URL used for marking a single notification as read
+ * Output the URL used for marking a single notification as read.
  *
  * Since this function directly outputs a URL, it is escaped.
@@ -886 +888 @@
 }
         /**
-         * Return the URL used for marking a single notification as read
+         * Return the URL used for marking a single notification as read.
          *
          * @since BuddyPress (2.1.0)
@@ -952 +954 @@
 
 /**
- * Output the URL used for marking a single notification as unread
+ * Output the URL used for marking a single notification as unread.
  *
  * Since this function directly outputs a URL, it is escaped.
@@ -964 +966 @@
 }
         /**
-         * Return the URL used for marking a single notification as unread
+         * Return the URL used for marking a single notification as unread.
          *
          * @since BuddyPress (2.1.0)
@@ -1063 +1065 @@
 
 /**
- * Output the URL used for deleting a single notification
+ * Output the URL used for deleting a single notification.
  *
  * Since this function directly outputs a URL, it is escaped.
@@ -1076 +1078 @@
 }
         /**
-         * Return the URL used for deleting a single notification
+         * Return the URL used for deleting a single notification.
          *
          * @since BuddyPress (2.1.0)
@@ -1119 +1121 @@
  * Output the action links for the current notification.
  *
+ * @param array|string $args Array of arguments.
  * @since BuddyPress (1.9.0)
  */
@@ -1129 +1132 @@
          * @since BuddyPress (1.9.0)
          *
-         * @param array $args {
+         * @param array|string $args {
          *     @type string $before HTML before the links.
-         *     @type string $after HTML after the links.
-         *     @type string $sep HTML between the links.
-         *     @type array $links Array of links to implode by 'sep'.
+         *     @type string $after  HTML after the links.
+         *     @type string $sep    HTML between the links.
+         *     @type array  $links  Array of links to implode by 'sep'.
          * }
          *
@@ -1232 +1235 @@
 
 /**
- * Output the form for changing the sort order of notifications
+ * Output the form for changing the sort order of notifications.
  *
  * @since BuddyPress (1.9.0)