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

Timestamp:

09/18/2017 08:21:04 PM (7 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/parse.php (modified) (2 diffs)

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

@@ -7 +7 @@
 
 /**
-* Parses a user agent string into its important parts
-*
-* @param string $user_agent
-*
-* @return array containing platform, name, and version
-*/
+ * Parses a user agent string into its important parts.
+ *
+ * @param string $user_agent The user agent string for a browser.
+ * @return array {
+ *     Array containing data based on the parsing of the user agent.
+ *
+ *     @type string $platform        The platform running the browser.
+ *     @type string $name            The name of the browser.
+ *     @type string $version         The reported version of the browser.
+ *     @type string $update_url      The URL to obtain the update 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.
+ *     @type string $current_version The current latest version of the browser.
+ *     @type bool   $upgrade         Is there an update available for the browser?
+ *     @type bool   $insecure        Is the browser insecure?
+ * }
+ */
 function browsehappy_parse_user_agent( $user_agent ) {
     $data = array();
@@ -104 +115 @@
 }
 
+/**
+ * Returns the current version for the given browser.
+ *
+ * @param string $name The name of the browser.
+ * @return string      The version for the browser or an empty string if an
+ *                     unknown browser.
+ */
 function get_browser_version_from_name( $name ) {
     $versions = get_browser_current_versions();