Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/02/2015 05:21:07 AM (9 years ago)
Author:
tw2113
Message:

Initial documentation cleanup for the BP Groups component.

See #6401.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-groups/bp-groups-forums.php

    r9819 r9906  
    22
    33/**
    4  * BuddyPress Groups Forums
     4 * BuddyPress Groups Forums.
    55 *
    66 * Action functions are exactly the same as screen functions, however they do not
    … …  
    2525 * @since BuddyPress (1.0.0)
    2626 *
    27  * @param int $group_id The group ID that the new forum should be attached to.
     27 * @param int    $group_id  The group ID that the new forum should be attached to.
    2828 * @param string $group_name The group name.
    2929 * @param string $group_desc The group description.
    … …  
    6767 *
    6868 * @param int $group_id Group id, passed from groups_details_updated.
     69 *
     70 * @return mixed
    6971 */
    7072function groups_update_group_forum( $group_id ) {
    … …  
    107109 *
    108110 * @param string $post_text The text for the forum post.
    109  * @param int $topic_id The topic ID used so we can identify where the new
    110  *        forum post should reside.
    111  * @param mixed $page The page number where the new forum post should reside.
    112  *        Default: false.
     111 * @param int    $topic_id  The topic ID used so we can identify where the new
     112 *                          forum post should reside.
     113 * @param mixed  $page      The page number where the new forum post should reside.
     114 *                          Default: false.
     115 *
    113116 * @return mixed The new forum post ID on success. Boolean false on failure.
    114117 */
    … …  
    216219 *
    217220 * @param string $topic_title The title for the forum topic.
    218  * @param string $topic_text The text for the forum topic.
    219  * @param string $topic_tags A comma-delimited string of topic tags.
    220  * @param int $forum_id The forum ID this forum topic resides in.
     221 * @param string $topic_text  The text for the forum topic.
     222 * @param string $topic_tags  A comma-delimited string of topic tags.
     223 * @param int    $forum_id    The forum ID this forum topic resides in.
     224 *
    221225 * @return mixed The new topic object on success. Boolean false on failure.
    222226 */
    … …  
    335339 * @since BuddyPress (1.1.0)
    336340 *
    337  * @param int $topic_id The topic ID of the existing forum topic.
     341 * @param int    $topic_id    The topic ID of the existing forum topic.
    338342 * @param string $topic_title The title for the forum topic.
    339  * @param string $topic_text The text for the forum topic.
    340  * @param mixed $topic_tags A comma-delimited string of topic tags. Optional.
     343 * @param string $topic_text  The text for the forum topic.
     344 * @param mixed  $topic_tags  A comma-delimited string of topic tags. Optional.
     345 *
    341346 * @return mixed The topic object on success. Boolean false on failure.
    342347 */
    … …  
    413418 * @since BuddyPress (1.1.0)
    414419 *
    415  * @param int $post_id The post ID of the existing forum post.
     420 * @param int    $post_id  The post ID of the existing forum post.
    416421 * @param string $post_text The text for the forum post.
    417  * @param int $topic_id The topic ID of the existing forum topic.
    418  * @param mixed $page The page number where the new forum post should reside.
    419  *    Optional.
     422 * @param int    $topic_id The topic ID of the existing forum topic.
     423 * @param mixed  $page      The page number where the new forum post should reside. Optional.
     424 *
    420425 * @return mixed The forum post ID on success. Boolean false on failure.
    421426 */
    … …  
    503508 *
    504509 * @param int $topic_id The ID of the topic to be deleted.
     510 *
    505511 * @return bool True if the delete routine went through properly.
    506512 */
    … …  
    565571 * @since BuddyPress (1.1.0)
    566572 *
    567  * @param int $post_id The ID of the post you want to delete.
    568  * @param int $topic_id Optional. The topic to which the post belongs. This
    569  *        value isn't used in the function but is passed along to do_action()
    570  *        hooks.
     573 * @param int      $post_id  The ID of the post you want to delete.
     574 * @param int|bool $topic_id Optional. The topic to which the post belongs. This
     575 *                           value isn't used in the function but is passed along
     576 *                           to do_action() hooks.
     577 *
    571578 * @return bool True on success.
    572579 */
    … …  
    617624 *
    618625 * @param string $type Either 'newest', 'popular', 'unreplied', 'tags'.
    619  *        Default: 'newest'.
     626 *                     Default: 'newest'.
     627 *
    620628 * @return int The topic count.
    621629 */
    … …  
    637645 * @since BuddyPress (1.5.0)
    638646 *
    639  * @param string $status Which groups to count. 'public', 'private', 'hidden',
    640  *        'all'. Default: 'public'.
    641  * @param string $search_terms Optional. Limit by a search term.
     647 * @param string      $status       Which groups to count. 'public', 'private', 'hidden',
     648 *                                  'all'. Default: 'public'.
     649 * @param string|bool $search_terms Optional. Limit by a search term.
     650 *
    642651 * @return int The topic count.
    643652 */
Note: See TracChangeset for help on using the changeset viewer.