Upgrade to ExtJS 4.0.7 - Released 10/19/2011

[extjs.git] / src / core / src / env / OS.js

diff --git a/src/core/src/env/OS.js b/src/core/src/env/OS.js
index 540f927..83910be 100644 (file)
--- a/src/core/src/env/OS.js
+++ b/src/core/src/env/OS.js
@@ -1,19 +1,33 @@
+/*
+
+This file is part of Ext JS 4
+
+Copyright (c) 2011 Sencha Inc
+
+Contact:  http://www.sencha.com/contact
+
+GNU General Public License Usage
+This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file.  Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.
+
+If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact.
+
+*/
 /**
  * @class Ext.env.OS
- * Provide useful information about the current operating system environment. Access the global instance stored in Ext.os. Example:
- * <pre><code>
- * if (Ext.os.is.Windows) {
- *      // Windows specific code here
- * }
+ * Provides useful information about the current operating system environment.
+ * Access the global instance stored in {@link Ext#os}. Example:
  *
- * if (Ext.os.is.iOS) {
- *      // iPad, iPod, iPhone, etc.
- * }
+ *     if (Ext.os.is.Windows) {
+ *          // Windows specific code here
+ *     }
  *
- * console.log("Version " + Ext.os.version);
- * </code></pre>
+ *     if (Ext.os.is.iOS) {
+ *          // iPad, iPod, iPhone, etc.
+ *     }
  *
- * For a full list of supported values, refer to: {@link Ext.env.OS#is Ext.env.OS.is}
+ *     console.log("Version " + Ext.os.version);
+ *
+ * For a full list of supported values, refer to: {@link Ext.env.OS#is}
  */
 Ext.define('Ext.env.OS', {
 
@@ -36,23 +50,20 @@ Ext.define('Ext.env.OS', {
         }
     },
 
-    /*
+    /**
      * A "hybrid" property, can be either accessed as a method call, i.e:
-     * <pre><code>
-     * if (Ext.os.is('Android')) { ... }
-     * </code></pre>
+     *
+     *     if (Ext.os.is('Android')) { ... }
      *
      * or as an object with boolean properties, i.e:
-     * <pre><code>
-     * if (Ext.os.is.Android) { ... }
-     * </code></pre>
+     *
+     *     if (Ext.os.is.Android) { ... }
      *
      * Versions can be conveniently checked as well. For example:
-     * <pre><code>
-     * if (Ext.os.is.Android2) { ... } // Equivalent to (Ext.os.is.Android && Ext.os.version.equals(2))
      *
-     * if (Ext.os.is.iOS32) { ... } // Equivalent to (Ext.os.is.iOS && Ext.os.version.equals(3.2))
-     * </code></pre>
+     *     if (Ext.os.is.Android2) { ... } // Equivalent to (Ext.os.is.Android && Ext.os.version.equals(2))
+     * 
+     *     if (Ext.os.is.iOS32) { ... } // Equivalent to (Ext.os.is.iOS && Ext.os.version.equals(3.2))
      *
      * Note that only {@link Ext.Version#getMajor major component}  and {@link Ext.Version#getShortVersion shortVersion}
      * value of the version are available via direct property checking.
@@ -61,19 +72,20 @@ Ext.define('Ext.env.OS', {
      *
      * @param {String} value The OS name to check
      * @return {Boolean}
+     * @method
      */
     is: Ext.emptyFn,
 
-    /*
+    /**
+     * @property {String} name
      * Read-only - the full name of the current operating system
      * Possible values are: iOS, Android, WebOS, BlackBerry, MacOSX, Windows, Linux and Other
-     * @type String
      */
     name: null,
 
-    /*
+    /**
+     * @property {Ext.Version} version
      * Read-only, refer to {@link Ext.Version}
-     * @type Ext.Version
      */
     version: null,
 
@@ -127,6 +139,12 @@ Ext.define('Ext.env.OS', {
     }
 }, function() {
 
-Ext.os = new Ext.env.OS();
+    /**
+     * @property {Ext.env.OS} os
+     * @member Ext
+     * Global convenient instance of {@link Ext.env.OS}.
+     */
+    Ext.os = new Ext.env.OS();
 
 });
+