Changeset 10012 for trunk/src/bp-core/bp-core-catchuri.php

Timestamp:

07/12/2015 12:49:36 AM (11 years ago)

Author:

tw2113

Message:

First pass at BP-Core docs cleanup.

See #6398.

File:

• trunk/src/bp-core/bp-core-catchuri.php (modified) (4 diffs)

trunk/src/bp-core/bp-core-catchuri.php

@@ -370 +370 @@
  *
  * @param array $templates Array of templates to attempt to load.
+ *
  * @return bool|null Returns false on failure.
  */
@@ -518 +519 @@
  * @since BuddyPress (1.5.0)
  *
- * @param array $args {
- *     @type int $mode Specifies the destination of the redirect. 1 will
- *           direct to the root domain (home page), which assumes you have a
- *           log-in form there; 2 directs to wp-login.php. Default: 2.
- *     @type string $redirect The URL the user will be redirected to after
- *           successfully logging in. Default: the URL originally requested.
- *     @type string $root The root URL of the site, used in case of error or
- *           mode 1 redirects. Default: the value of {@link bp_get_root_domain()}.
- *     @type string $message An error message to display to the user on the
- *           log-in page. Default: "You must log in to access the page you
- *           requested."
+ * @param array|string $args {
+ *     @type int    $mode     Specifies the destination of the redirect. 1 will
+ *                            direct to the root domain (home page), which assumes you have a
+ *                            log-in form there; 2 directs to wp-login.php. Default: 2.
+ *     @type string $redirect The URL the user will be redirected to after successfully
+ *                            logging in. Default: the URL originally requested.
+ *     @type string $root     The root URL of the site, used in case of error or mode 1 redirects.
+ *                            Default: the value of {@link bp_get_root_domain()}.
+ *     @type string $message  An error message to display to the user on the log-in page.
+ *                            Default: "You must log in to access the page you requested."
  * }
  */
@@ -606 +606 @@
  * @since BuddyPress (1.5.0)
  *
- * @global $error Error message to pass to wp-login.php
+ * @global string $error Error message to pass to wp-login.php.
  */
 function bp_core_no_access_wp_login_error() {
@@ -716 +716 @@
  *     Optional array of arguments.
  *     @type bool $include_query_args Whether to include current URL arguments
- *           in the canonical URL returned from the function.
+ *                                    in the canonical URL returned from the function.
  * }
+ *
  * @return string Canonical URL for the current page.
  */