Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/19/2015 01:40:26 AM (11 years ago)
Author:
tw2113
Message:

First pass at members component docs cleanup.

See #6402.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-members/bp-members-widgets.php

    r9819 r9877  
    11<?php
    22/**
    3  * BuddyPress Members Widgets
     3 * BuddyPress Members Widgets.
    44 *
    55 * @package BuddyPress
    … …  
    3131
    3232        /**
    33          * Constructor method
     33         * Constructor method.
    3434         */
    3535        public function __construct() {
    … …  
    153153         * Update the Members widget options.
    154154         *
    155          * @param  array $new_instance The new instance options.
    156          * @param  array $old_instance The old instance options.
     155         * @param array $new_instance The new instance options.
     156         * @param array $old_instance The old instance options.
     157         *
    157158         * @return array $instance     The parsed options to be saved.
    158159         */
    … …  
    171172         * Output the Members widget options form.
    172173         *
    173          * @param $instance Settings for this widget.
     174         * @param array $instance Widget instance settings.
     175         *
     176         * @return string
    174177         */
    175178        public function form( $instance ) {
    … …  
    221224         * @since BuddyPress (2.3.0)
    222225         *
    223          * @param $instance Instance
    224          * @uses bp_parse_args() To merge widget settings into defaults
     226         * @param array $instance Widget instance settings.
     227         *
     228         * @uses bp_parse_args() To merge widget settings into defaults.
     229         *
     230         * @return array
    225231         */
    226232        public function parse_settings( $instance = array() ) {
    … …  
    321327         * Update the Who's Online widget options.
    322328         *
    323          * @param  array $new_instance The new instance options.
    324          * @param  array $old_instance The old instance options.
     329         * @param array $new_instance The new instance options.
     330         * @param array $old_instance The old instance options.
     331         *
    325332         * @return array $instance     The parsed options to be saved.
    326333         */
    … …  
    336343         * Output the Who's Online widget options form.
    337344         *
    338          * @param $instance Settings for this widget.
     345         * @param array $instance Widget instance settings.
     346         *
     347         * @return string
    339348         */
    340349        public function form( $instance ) {
    … …  
    367376         * @since BuddyPress (2.3.0)
    368377         *
    369          * @param $instance Instance
    370          * @uses bp_parse_args() To merge widget settings into defaults
     378         * @param array $instance Widget instance settings.
     379         *
     380         * @uses bp_parse_args() To merge widget settings into defaults.
     381         *
     382         * @return array
    371383         */
    372384        public function parse_settings( $instance = array() ) {
    … …  
    467479         * @param array $new_instance The new instance options.
    468480         * @param array $old_instance The old instance options.
     481         *
    469482         * @return array $instance The parsed options to be saved.
    470483         */
    … …  
    480493         * Output the Recently Active widget options form.
    481494         *
    482          * @param $instance Settings for this widget.
     495         * @param array $instance Widget instance settings.
     496         *
     497         * @return string
    483498         */
    484499        public function form( $instance ) {
    … …  
    511526         * @since BuddyPress (2.3.0)
    512527         *
    513          * @param $instance Instance
    514          * @uses bp_parse_args() To merge widget settings into defaults
     528         * @param array $instance Widget instance settings.
     529         *
     530         * @uses bp_parse_args() To merge widget settings into defaults.
     531         *
     532         * @return array
    515533         */
    516534        public function parse_settings( $instance = array() ) {
Note: See TracChangeset for help on using the changeset viewer.