Changeset 5935 for sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/browsers.php

Timestamp:

09/18/2017 08:21:04 PM (8 years ago)

Author:

coffee2code

Message:

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

File:

• sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/browsers.php (modified) (2 diffs)

sites/trunk/api.wordpress.org/public_html/core/browse-happy/1.0/browsers.php

@@ -8 +8 @@
 
 /**
- * Browser current version numbers.
+ * Returns current version numbers for all browsers.
  *
  * These are for major release branches, not full build numbers.
  * Firefox 3.6, 4, etc., not Chrome 11.0.696.65.
+ *
+ * @return array Associative array of browser names with their respective
+ *               current (or somewhat current) version number.
  */
 function get_browser_current_versions() {
@@ -23 +26 @@
 }
 
+/**
+ * Returns browser data for a given browser.
+ *
+ * @param string|false $browser The name of the browser. Default false.
+ * @return false|array {
+ *     Array of data about the browser. False if the browser is unknown.
+ *
+ *     @type string    $name        Name of the browser.
+ *     @type string    $wikipedia   Wikipedia name for the browser.
+ *     @type int|float $normalized  How should browser version number be
+ *                                  normalized? 1 == just first number, else
+ *                                  include second number (i.e. decimal value)
+ *     @type string    $url         The home URL for the browser.
+ *     @type string    $img_src     The non-HTTPs URL for the browser's logo image.
+ *     @type string    $img_src_ssl The HTTPS URL for the browser's logo image.
+ * }
+ */
 function browsehappy_api_get_browser_data( $browser = false ) {