Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
10/11/2015 04:27:50 PM (5 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-forums/bp-forums-template.php

    r10183 r10248  
    109109     * The loop iterator.
    110110     *
    111      * @access public
    112111     * @var int
    113112     */
     
    117116     * The number of topics returned by the paged query.
    118117     *
    119      * @access public
    120118     * @var int
    121119     */
     
    125123     * Array of topics located by the query.
    126124     *
    127      * @access public
    128125     * @var array
    129126     */
     
    133130     * The topic object currently being iterated on.
    134131     *
    135      * @access public
    136132     * @var object
    137133     */
     
    141137     * The ID of the forum whose topics are being queried.
    142138     *
    143      * @access public
    144139     * @var int
    145140     */
     
    149144     * A flag for whether the loop is currently being iterated.
    150145     *
    151      * @access public
    152146     * @var bool
    153147     */
     
    157151     * The page number being requested.
    158152     *
    159      * @access public
    160153     * @var int
    161154     */
     
    165158     * The number of items being requested per page.
    166159     *
    167      * @access public
    168160     * @var int
    169161     */
     
    173165     * An HTML string containing pagination links.
    174166     *
    175      * @access public
    176167     * @var string
    177168     */
     
    181172     * The total number of topics matching the query parameters.
    182173     *
    183      * @access public
    184174     * @var int
    185175     */
     
    189179     * Whether requesting a single topic. Not currently used.
    190180     *
    191      * @access public
    192181     * @var bool
    193182     */
     
    197186     * Term to sort by. Not currently used.
    198187     *
    199      * @access public
    200188     * @var string
    201189     */
     
    205193     * Sort order. Not currently used.
    206194     *
    207      * @access public
    208195     * @var string
    209196     */
     
    19241911     * The loop iterator.
    19251912     *
    1926      * @access public
    19271913     * @var int
    19281914     */
     
    19321918     * The number of posts returned by the paged query.
    19331919     *
    1934      * @access public
    19351920     * @var int
    19361921     */
     
    19401925     * Array of posts located by the query.
    19411926     *
    1942      * @access public
    19431927     * @var array
    19441928     */
     
    19481932     * The post object currently being iterated on.
    19491933     *
    1950      * @access public
    19511934     * @var object
    19521935     */
     
    19561939     * The ID of the forum whose topic is being queried.
    19571940     *
    1958      * @access public
    19591941     * @var int
    19601942     */
     
    19641946     * The ID of the topic whose posts are being queried.
    19651947     *
    1966      * @access public
    19671948     * @var int
    19681949     */
     
    19721953     * The topic object to which the posts belong.
    19731954     *
    1974      * @access public
    19751955     * @var object
    19761956     */
     
    19801960     * A flag for whether the loop is currently being iterated.
    19811961     *
    1982      * @access public
    19831962     * @var bool
    19841963     */
     
    19971976     * The page number being requested.
    19981977     *
    1999      * @access public
    20001978     * @var int
    20011979     */
     
    20051983     * The number of items being requested per page.
    20061984     *
    2007      * @access public
    20081985     * @var int
    20091986     */
     
    20131990     * An HTML string containing pagination links.
    20141991     *
    2015      * @access public
    20161992     * @var string
    20171993     */
     
    20211997     * The total number of posts matching the query parameters.
    20221998     *
    2023      * @access public
    20241999     * @var int
    20252000     */
     
    20292004     * Whether requesting a single topic. Not currently used.
    20302005     *
    2031      * @access public
    20322006     * @var bool
    20332007     */
     
    20372011     * Term to sort by.
    20382012     *
    2039      * @access public
    20402013     * @var string
    20412014     */
     
    20452018     * Sort order.
    20462019     *
    2047      * @access public
    20482020     * @var string
    20492021     */
Note: See TracChangeset for help on using the changeset viewer.