Make WordPress Core


Ignore:
Timestamp:
05/31/2015 03:17:50 AM (9 years ago)
Author:
wonderboymusic
Message:

Add doc blocks to functions that are missing them.
If the function has no need for @param or @return, do an archeaological dig to find @since.

See #32444.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/pomo/mo.php

    r30663 r32672  
    2828    }
    2929
     30    /**
     31     * @param string $filename
     32     * @return bool
     33     */
    3034    function export_to_file($filename) {
    3135        $fh = fopen($filename, 'wb');
     
    3640    }
    3741
     42    /**
     43     * @return string|false
     44     */
    3845    function export() {
    3946        $tmp_fh = fopen("php://temp", 'r+');
     
    4451    }
    4552
     53    /**
     54     * @param Translation_Entry $entry
     55     * @return bool
     56     */
    4657    function is_entry_good_for_export( $entry ) {
    4758        if ( empty( $entry->translations ) ) {
     
    5667    }
    5768
     69    /**
     70     * @param resource $fh
     71     * @return true
     72     */
    5873    function export_to_file_handle($fh) {
    5974        $entries = array_filter( $this->entries, array( $this, 'is_entry_good_for_export' ) );
     
    102117    }
    103118
     119    /**
     120     * @param Translation_Entry $entry
     121     * @return string
     122     */
    104123    function export_original($entry) {
    105124        //TODO: warnings for control characters
     
    110129    }
    111130
     131    /**
     132     * @param Translation_Entry $entry
     133     * @return string
     134     */
    112135    function export_translations($entry) {
    113136        //TODO: warnings for control characters
     
    115138    }
    116139
     140    /**
     141     * @return string
     142     */
    117143    function export_headers() {
    118144        $exported = '';
     
    123149    }
    124150
     151    /**
     152     * @param int $magic
     153     * @return string|false
     154     */
    125155    function get_byteorder($magic) {
    126156        // The magic is 0x950412de
     
    255285    }
    256286
     287    /**
     288     * @param int $count
     289     * @return string
     290     */
    257291    function select_plural_form($count) {
    258292        return $this->gettext_select_plural_form($count);
    259293    }
    260294
     295    /**
     296     * @return int
     297     */
    261298    function get_plural_forms_count() {
    262299        return $this->_nplurals;
Note: See TracChangeset for help on using the changeset viewer.