Changeset 9833 for trunk/src/bp-activity/classes/class-bp-activity-query.php

Timestamp:

05/03/2015 06:51:25 PM (10 years ago)

Author:

tw2113

Message:

First pass at cleanup of Activity component documetnation.

See #6396.

File:

• trunk/src/bp-activity/classes/class-bp-activity-query.php (modified) (4 diffs)

trunk/src/bp-activity/classes/class-bp-activity-query.php

@@ -91 +91 @@
      *
      * @param string $alias An existing table alias that is compatible with the current query clause.
-     *               Default: 'a'. BP_Activity_Activity::get() uses 'a', so we default to that.
+     *                      Default: 'a'. BP_Activity_Activity::get() uses 'a', so we default to that.
+     *
      * @return string SQL fragment to append to the main WHERE clause.
      */
@@ -116 +117 @@
      * @param  array $clause       Array of arguments belonging to the clause.
      * @param  array $parent_query Parent query to which the clause belongs.
+     *
      * @return array {
      *     @type array $where Array of subclauses for the WHERE statement.
@@ -226 +228 @@
      * @access protected
      *
-     * @param  array $query Clause to check.
+     * @param array $query Clause to check.
+     *
      * @return bool
      */
@@ -243 +246 @@
      *
      * @param string $column The user-supplied column name.
+     *
      * @return string A validated column name value.
      */