WordPress.org

Making WordPress.org


Ignore:
Timestamp:
09/18/2017 08:21:04 PM (2 years ago)
Author:
coffee2code
Message:

Browse Happy API: Add missing docblocks and improve the existing ones.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/browsers.php

    r5934 r5935  
    88
    99/**
    10  * Browser current version numbers.
     10 * Returns current version numbers for all browsers.
    1111 *
    1212 * These are for major release branches, not full build numbers.
    1313 * Firefox 3.6, 4, etc., not Chrome 11.0.696.65.
     14 *
     15 * @return array Associative array of browser names with their respective
     16 *               current (or somewhat current) version number.
    1417 */
    1518function get_browser_current_versions() {
     
    2326}
    2427
     28/**
     29 * Returns browser data for a given browser.
     30 *
     31 * @param string|false $browser The name of the browser. Default false.
     32 * @return false|array {
     33 *     Array of data about the browser. False if the browser is unknown.
     34 *
     35 *     @type string    $name        Name of the browser.
     36 *     @type string    $wikipedia   Wikipedia name for the browser.
     37 *     @type int|float $normalized  How should browser version number be
     38 *                                  normalized? 1 == just first number, else
     39 *                                  include second number (i.e. decimal value)
     40 *     @type string    $url         The home URL for the browser.
     41 *     @type string    $img_src     The non-HTTPs URL for the browser's logo image.
     42 *     @type string    $img_src_ssl The HTTPS URL for the browser's logo image.
     43 * }
     44 */
    2545function browsehappy_api_get_browser_data( $browser = false ) {
    2646
Note: See TracChangeset for help on using the changeset viewer.