Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
10/11/2015 04:27:50 PM (11 years ago)
Author:
djpaul
Message:

phpdoc: remove obsolete @access public|protected|private statements.

These should only be used on procedural functions that, for legacy
reasons, pretend they are private by prefacing their name with an
underscore.

As modern PHP parsers and IDEs use reflections to figure out the
visibility scope of methods and properties by looking at the actual
code, there’s also no bonus in keeping these purely for documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-messages/bp-messages-template.php

    r10139 r10248  
    1818         * The loop iterator.
    1919         *
    20          * @access public
    2120         * @var int
    2221         */
     
    2625         * The number of threads returned by the paged query.
    2726         *
    28          * @access public
    2927         * @var int
    3028         */
     
    3432         * Total number of threads matching the query params.
    3533         *
    36          * @access public
    3734         * @var int
    3835         */
     
    4239         * Array of threads located by the query.
    4340         *
    44          * @access public
    4541         * @var array
    4642         */
     
    5046         * The thread object currently being iterated on.
    5147         *
    52          * @access public
    5348         * @var object
    5449         */
     
    5853         * A flag for whether the loop is currently being iterated.
    5954         *
    60          * @access public
    6155         * @var bool
    6256         */
     
    6660         * User ID of the current inbox.
    6761         *
    68          * @access public
    6962         * @var int
    7063         */
     
    7467         * The current "box" view ('notices', 'sentbox', 'inbox').
    7568         *
    76          * @access public
    7769         * @var string
    7870         */
     
    8274         * The page number being requested.
    8375         *
    84          * @access public
    8576         * @var int
    8677         */
     
    9081         * The number of items being requested per page.
    9182         *
    92          * @access public
    9383         * @var int
    9484         */
     
    9888         * An HTML string containing pagination links.
    9989         *
    100          * @access public
    10190         * @var string
    10291         */
     
    10695         * Search terms for limiting the thread query.
    10796         *
    108          * @access public
    10997         * @var string
    11098         */
     
    17721760         * The loop iterator.
    17731761         *
    1774          * @access public
    17751762         * @var int
    17761763         */
     
    17801767         * Number of messages returned by the paged query.
    17811768         *
    1782          * @access public
    17831769         * @var int
    17841770         */
     
    17881774         * The message object currently being iterated on.
    17891775         *
    1790          * @access public
    17911776         * @var object
    17921777         */
     
    17961781         * Thread that the current messages belong to.
    17971782         *
    1798          * @access public
    17991783         * @var BP_Messages_Thread
    18001784         */
     
    18041788         * A flag for whether the loop is currently being iterated.
    18051789         *
    1806          * @access public
    18071790         * @var bool
    18081791         */
     
    18121795         * The page number being requested.
    18131796         *
    1814          * @access public
    18151797         * @var int
    18161798         */
     
    18201802         * The number of items being requested per page.
    18211803         *
    1822          * @access public
    18231804         * @var int
    18241805         */
     
    18281809         * An HTML string containing pagination links.
    18291810         *
    1830          * @access public
    18311811         * @var string
    18321812         */
     
    18361816         * The total number of messages matching the query.
    18371817         *
    1838          * @access public
    18391818         * @var int
    18401819         */
Note: See TracChangeset for help on using the changeset viewer.