Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
07/11/2015 11:12:52 PM (11 years ago)
Author:
tw2113
Message:

Initial documentation cleanup for the BP Blogs component.

See #6397.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-blogs/bp-blogs-activity.php

    r9958 r10011  
    6565 * @since BuddyPress (2.0.0)
    6666 *
    67  * @param string $action Static activity action.
    68  * @param obj $activity Activity data object.
     67 * @param string $action   Static activity action.
     68 * @param object $activity Activity data object.
     69 *
     70 * @return string
    6971 */
    7072function bp_blogs_format_activity_action_new_blog( $action, $activity ) {
    … …  
    9294     *
    9395     * @param string $action   Constructed activity action.
    94      * @param obj    $activity Activity data object.
     96     * @param object $activity Activity data object.
    9597     */
    9698    return apply_filters( 'bp_blogs_format_activity_action_new_blog', $action, $activity );
    … …  
    102104 * @since BuddyPress (2.0.0)
    103105 *
    104  * @param string $action Static activity action.
    105  * @param obj $activity Activity data object.
     106 * @param string $action   Static activity action.
     107 * @param object $activity Activity data object.
     108 *
     109 * @return string Constructed activity action.
    106110 */
    107111function bp_blogs_format_activity_action_new_blog_post( $action, $activity ) {
    … …  
    202206     *
    203207     * @param string $action   Constructed activity action.
    204      * @param obj    $activity Activity data object.
     208     * @param object $activity Activity data object.
    205209     */
    206210    return apply_filters( 'bp_blogs_format_activity_action_new_blog_post', $action, $activity );
    … …  
    212216 * @since BuddyPress (2.0.0)
    213217 *
    214  * @param string $action Static activity action.
    215  * @param obj $activity Activity data object.
     218 * @param string $action   Static activity action.
     219 * @param object $activity Activity data object.
     220 *
     221 * @return string Constructed activity action.
    216222 */
    217223function bp_blogs_format_activity_action_new_blog_comment( $action, $activity ) {
    … …  
    277283     *
    278284     * @param string $action   Constructed activity action.
    279      * @param obj    $activity Activity data object.
     285     * @param object $activity Activity data object.
    280286     */
    281287    return apply_filters( 'bp_blogs_format_activity_action_new_blog_comment', $action, $activity );
    … …  
    290296 *
    291297 * @param array $activities Array of activity items.
     298 *
    292299 * @return array
    293300 */
    … …  
    322329 * @see bp_activity_add() for description of parameters.
    323330 *
    324  * @param array $args {
     331 * @param array|string $args {
    325332 *     See {@link bp_activity_add()} for complete description of arguments.
    326333 *     The arguments listed here have different default values from
    … …  
    399406 * @see bp_activity_delete() for description of parameters.
    400407 *
    401  * @param array $args {
     408 * @param array|string $args {
    402409 *     See {@link bp_activity_delete()} for complete description of arguments.
    403410 *     The arguments listed here have different default values from
    … …  
    439446 *
    440447 * @param object $activity The BP_Activity_Activity object
     448 *
    441449 * @return bool
    442450 */
    … …  
    523531 * @since BuddyPress (2.0.0)
    524532 *
    525  * @param int $comment_id The activity ID for the posted activity comment.
    526  * @param array $params Parameters for the activity comment.
    527  * @param object Parameters of the parent activity item (in this case, the blog post).
     533 * @param int    $comment_id      The activity ID for the posted activity comment.
     534 * @param array  $params          Parameters for the activity comment.
     535 * @param object $parent_activity Parameters of the parent activity item (in this case, the blog post).
    528536 */
    529537function bp_blogs_sync_add_from_activity_comment( $comment_id, $params, $parent_activity ) {
    … …  
    630638 *
    631639 * @param bool $retval
    632  * @param int $parent_activity_id The parent activity ID for the activity comment.
    633  * @param int $activity_id The activity ID for the pending deleted activity comment.
     640 * @param int  $parent_activity_id The parent activity ID for the activity comment.
     641 * @param int  $activity_id        The activity ID for the pending deleted activity comment.
     642 *
     643 * @return bool
    634644 */
    635645function bp_blogs_sync_delete_from_activity_comment( $retval, $parent_activity_id, $activity_id ) {
    … …  
    732742 * @since BuddyPress (2.0.0)
    733743 *
    734  * @param int $post_id The post ID
     744 * @param int   $post_id  The post ID.
    735745 * @param array $comments Array of comment statuses. The key is comment ID, the
    736  *        value is the $comment->comment_approved value.
     746 *                        value is the $comment->comment_approved value.
    737747 */
    738748function bp_blogs_remove_activity_meta_for_trashed_comments( $post_id = 0, $comments = array() ) {
    … …  
    764774 *
    765775 * @param array $args Arguments passed from bp_parse_args() in bp_has_activities().
     776 *
    766777 * @return array $args
    767778 */
    … …  
    837848 * @see bp_blogs_setup_comment_loop_globals_on_ajax()
    838849 *
    839  * @param object $activity The BP_Activity_Activity object
     850 * @param object $activity The BP_Activity_Activity object.
    840851 */
    841852function bp_blogs_setup_activity_loop_globals( $activity ) {
    … …  
    919930 *
    920931 * @param bool $retval Is activity commenting enabled for this activity entry?
     932 *
    921933 * @return bool
    922934 */
    … …  
    969981 * @since BuddyPress (2.0.0)
    970982 *
    971  * @param bool $retval Are replies allowed for this activity reply?
    972  * @param object $comment The activity comment object
     983 * @param bool   $retval  Are replies allowed for this activity reply?
     984 * @param object $comment The activity comment object.
     985 *
    973986 * @return bool
    974987 */
    … …  
    10071020 * @since BuddyPress (2.0.0)
    10081021 *
    1009  * @param string $retval The activity comment permalink
     1022 * @param string $retval The activity comment permalink.
     1023 *
    10101024 * @return string
    10111025 */
    … …  
    10341048 * @since BuddyPress (2.0.1)
    10351049 *
    1036  * @param string $retval The activity permalink
     1050 * @param string               $retval   The activity permalink.
    10371051 * @param BP_Activity_Activity $activity
     1052 *
    10381053 * @return string
    10391054 */
    … …  
    10601075 * @since BuddyPress (2.0.1)
    10611076 *
    1062  * @param string $retval The activity action
     1077 * @param string               $retval   The activity action.
    10631078 * @param BP_Activity_Activity $activity
     1079 *
    10641080 * @return string
    10651081 */
Note: See TracChangeset for help on using the changeset viewer.