Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
11/15/2015 07:57:03 PM (10 years ago)
Author:
tw2113
Message:

[Samus Aran]
I first battled the documentation inconsistencies on planet Zebes. It was there that I foiled the plans of the
Space Pirate leader Mother Brain to use the issues to attack galactic civilization...

I next fought the inconsistencies on their homeworld SR388. I completely eradicated them except for an @since tag,
which after hatching followed me like a confused child...

I personally delivered it to the Galactic Research Station at Ceres so scientists could study its energy production qualities...

The scientists' findings were astounding! They discovered that the powers of the docs inconsistencies
might be harnessed for the good of galactic civilization!

Satisfied that all was well, I left the station to seek a new bounty to hunt. But, I had hardly gone beyond the asteroid
belt when I picked up a distress signal!

Ceres station was under attack!

More documentation cleanup for part of BP-Core component.

See #6398.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-core/bp-core-wpabstraction.php

    r10108 r10356  
    4040
    4141    if ( !function_exists( 'get_blog_option' ) ) {
    42         /**
     42
     43        /**
     44         * Retrieve blog option.
     45         *
    4346         * @see get_blog_option()
     47         *
     48         * @param int    $blog_id     Blog ID to fetch for. Not used.
     49         * @param string $option_name Option name to fetch.
     50         * @param bool   $default     Whether or not default.
     51         *
     52         * @return mixed
    4453         */
    4554        function get_blog_option( $blog_id, $option_name, $default = false ) {
    … …  
    4958
    5059    if ( ! function_exists( 'add_blog_option' ) ) {
    51         /**
     60
     61        /**
     62         * Add blog option
     63         *
    5264         * @see add_blog_option()
     65         *
     66         * @param int    $blog_id      Blog ID to add for. Not used.
     67         * @param string $option_name  Option name to add.
     68         * @param mixed  $option_value Option value to add.
     69         *
     70         * @return mixed
    5371         */
    5472        function add_blog_option( $blog_id, $option_name, $option_value ) {
    … …  
    5876
    5977    if ( !function_exists( 'update_blog_option' ) ) {
    60         /**
     78
     79        /**
     80         * Update blog option.
     81         *
    6182         * @see update_blog_option()
     83         *
     84         * @param int    $blog_id     Blog ID to update for. Not used.
     85         * @param string $option_name Option name to update.
     86         * @param mixed  $value       Option value to update.
     87         *
     88         * @return mixed
    6289         */
    6390        function update_blog_option( $blog_id, $option_name, $value ) {
    … …  
    6794
    6895    if ( !function_exists( 'delete_blog_option' ) ) {
    69         /**
     96
     97        /**
     98         * Delete blog option.
     99         *
    70100         * @see delete_blog_option()
     101         *
     102         * @param int    $blog_id     Blog ID to delete for. Not used.
     103         * @param string $option_name Option name to delete.
     104         *
     105         * @return mixed
    71106         */
    72107        function delete_blog_option( $blog_id, $option_name ) {
    … …  
    76111
    77112    if ( !function_exists( 'switch_to_blog' ) ) {
    78         /**
     113
     114        /**
     115         * Switch to specified blog.
     116         *
    79117         * @see switch_to_blog()
     118         *
     119         * @param mixed $new_blog   New blog to switch to. Not used.
     120         * @param null  $deprecated Whether or not deprecated. Not used.
     121         *
     122         * @return int
    80123         */
    81124        function switch_to_blog( $new_blog, $deprecated = null ) {
    … …  
    85128
    86129    if ( !function_exists( 'restore_current_blog' ) ) {
    87         /**
     130
     131        /**
     132         * Restore current blog.
     133         *
    88134         * @see restore_current_blog()
     135         *
     136         * @return int
    89137         */
    90138        function restore_current_blog() {
    … …  
    94142
    95143    if ( !function_exists( 'get_blogs_of_user' ) ) {
    96         /**
     144
     145        /**
     146         * Retrive blogs associated with user.
     147         *
    97148         * @see get_blogs_of_user()
     149         *
     150         * @param int  $user_id ID of the user. Not used.
     151         * @param bool $all     Whether or not to return all. Not used.
     152         *
     153         * @return false
    98154         */
    99155        function get_blogs_of_user( $user_id, $all = false ) {
    … …  
    104160    if ( !function_exists( 'update_blog_status' ) ) {
    105161        /**
     162         * Whether or not to update blog status.
     163         *
    106164         * @see update_blog_status()
     165         *
     166         * @param int    $blog_id    Blog to update status for. Not used.
     167         * @param mixed  $pref       Preference. Not used.
     168         * @param string $value      Value. Not used.
     169         * @param null   $deprecated Whether or not deprecated. Not used.
     170         *
     171         * @return true
    107172         */
    108173        function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
    … …  
    113178    if ( !function_exists( 'is_subdomain_install' ) ) {
    114179        /**
     180         * Whether or not if subdomain install.
     181         *
    115182         * @see is_subdomain_install()
     183         *
     184         * @return bool
    116185         */
    117186        function is_subdomain_install() {
    … …  
    131200 *
    132201 * @param string|bool $prefix Global table prefix.
    133  *
    134202 * @return string SQL chunk.
    135203 */
    … …  
    155223     * @param string $str String to be measured.
    156224     * @param string $enc Optional. Encoding type. Ignored.
    157      *
    158225     * @return int String length.
    159226     */
    … …  
    162229        $total = 0;
    163230
    164         // Count ASCII bytes
     231        // Count ASCII bytes.
    165232        for( $i = 0; $i < 0x80; $i++ ) {
    166233            $total += $counts[$i];
    167234        }
    168235
    169         // Count multibyte sequence heads
     236        // Count multibyte sequence heads.
    170237        for( $i = 0xc0; $i < 0xff; $i++ ) {
    171238            $total += $counts[$i];
    … …  
    183250     * @param int    $offset Optional. Start position for the search. Default: 0.
    184251     * @param string $encoding Optional. Encoding type. Ignored.
    185      *
    186252     * @return int|bool Position of needle in haystack if found, else false.
    187253     */
    … …  
    208274     * @param int    $offset Optional. Start position for the search. Default: 0.
    209275     * @param string $encoding Optional. Encoding type. Ignored.
    210      *
    211276     * @return int Position of last needle in haystack if found, else false.
    212277     */
Note: See TracChangeset for help on using the changeset viewer.