Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
03/04/2017 06:26:55 PM (8 years ago)
Author:
tw2113
Message:

Cleanup from recent Scrutinizer review around documentation and param/return types.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-templates/bp-legacy/buddypress-functions.php

    r11438 r11447  
    613613 * @since 2.7.0
    614614 *
    615  * @return string html
     615 * @return string|null html
    616616 */
    617617function bp_legacy_groups_admin_screen_hidden_input() {
    … …  
    663663 * across page loads.
    664664 *
     665 * @since 1.2.0
     666 *
    665667 * @param string $query_string Query string for the current request.
    666668 * @param string $object       Object for cookie.
    667  * @return string Query string for the component loops
    668  * @since 1.2.0
     669 * @return string Query string for the component loops.
    669670 */
    670671function bp_legacy_theme_ajax_querystring( $query_string, $object ) {
    … …  
    772773 * Load the template loop for the current object.
    773774 *
    774  * @return string Prints template loop for the specified object
    775775 * @since 1.2.0
     776 *
     777 * @return string|null Prints template loop for the specified object
    776778 */
    777779function bp_legacy_theme_object_template_loader() {
    … …  
    817819 * @since 1.6.0
    818820 *
    819  * @return string Prints template loop for the Messages component.
     821 * @return string|null Prints template loop for the Messages component.
    820822 */
    821823function bp_legacy_theme_messages_template_loader() {
    … …  
    847849 * Load the activity loop template when activity is requested via AJAX.
    848850 *
    849  * @return string JSON object containing 'contents' (output of the template loop
    850  * for the Activity component) and 'feed_url' (URL to the relevant RSS feed).
    851  *
    852851 * @since 1.2.0
     852 *
     853 * @return string|null JSON object containing 'contents' (output of the template loop
     854 *                     for the Activity component) and 'feed_url' (URL to the relevant RSS feed).
    853855 */
    854856function bp_legacy_theme_activity_template_loader() {
    … …  
    903905 * Processes Activity updates received via a POST request.
    904906 *
    905  * @return string HTML
    906907 * @since 1.2.0
     908 *
     909 * @return string|null HTML
    907910 */
    908911function bp_legacy_theme_post_update() {
    … …  
    991994 * @global BP_Activity_Template $activities_template
    992995 *
    993  * @return string HTML
     996 * @return string|null HTML
    994997 */
    995998function bp_legacy_theme_new_activity_comment() {
    … …  
    11881191 * @since 1.2.0
    11891192 *
    1190  * @return string HTML
     1193 * @return string|null HTML
    11911194 */
    11921195function bp_legacy_theme_mark_activity_favorite() {
    … …  
    12081211 * @since 1.2.0
    12091212 *
    1210  * @return string HTML
     1213 * @return string|null HTML
    12111214 */
    12121215function bp_legacy_theme_unmark_activity_favorite() {
    … …  
    12291232 * @since 1.5.0
    12301233 *
    1231  * @return string HTML
     1234 * @return string|null HTML
    12321235 */
    12331236function bp_legacy_theme_get_single_activity_content() {
    … …  
    13521355 * @since 1.2.0
    13531356 *
    1354  * @return string HTML
     1357 * @return string|null HTML
    13551358 */
    13561359function bp_legacy_theme_ajax_addremove_friend() {
    … …  
    14461449 * @since 1.2.0
    14471450 *
    1448  * @return string HTML
     1451 * @return string|null HTML
    14491452 */
    14501453function bp_legacy_theme_ajax_joinleave_group() {
    … …  
    15471550 * @since 1.2.0
    15481551 *
    1549  * @return string HTML
     1552 * @return string|null HTML
    15501553 */
    15511554function bp_legacy_theme_ajax_messages_send_reply() {
    … …  
    16551658 * @since 1.2.0
    16561659 *
    1657  * @return string HTML
     1660 * @return string|null HTML
    16581661 */
    16591662function bp_legacy_theme_ajax_messages_delete() {
    … …  
    17621765 *
    17631766 * @param  array $params the current component's feature parameters.
    1764  * @return array          an array to inform about the css handle to attach the css rules to
     1767 * @return null|string An array to inform about the css handle to attach the css rules to
    17651768 */
    17661769function bp_legacy_theme_cover_image( $params = array() ) {
    … …  
    19351938 * @since 2.7.0
    19361939 *
    1937  * @return string HTML for the search form.
     1940 * @return string|null HTML for the search form.
    19381941 */
    19391942function bp_legacy_theme_group_manage_members_add_search() {
Note: See TracChangeset for help on using the changeset viewer.