/**
- * @class Ext.env.Browser
- * @extends Ext.Base
- * Provide useful information about the current browser.
- * Should not be manually instantiated unless for unit-testing; access the global instance stored in Ext.browser instead. Example:
- * <pre><code>
- * if (Ext.browser.is.IE) {
- * // IE specific code here
- * }
+ * Provides useful information about the current browser.
+ * Should not be manually instantiated unless for unit-testing; access the global instance
+ * stored in {@link Ext#browser} instead. Example:
*
- * if (Ext.browser.is.WebKit) {
- * // WebKit specific code here
- * }
+ * if (Ext.browser.is.IE) {
+ * // IE specific code here
+ * }
*
- * console.log("Version " + Ext.browser.version);
- * </code></pre>
+ * if (Ext.browser.is.WebKit) {
+ * // WebKit specific code here
+ * }
*
- * For a full list of supported values, refer to: {@link Ext.env.Browser#is}
+ * console.log("Version " + Ext.browser.version);
*
- * @borrows Ext.Base.extend
+ * For a full list of supported values, refer to: {@link Ext.env.Browser#is}
*/
Ext.define('Ext.env.Browser', {
statics: {
@@ -69,32 +65,29 @@ Ext.define('Ext.env.Browser', {
},
/**
- * True if the page is running over SSL
- * @type Boolean
+ * @property {Boolean} isSecure
+ * True if the page is running over SSL
*/
isSecure: false,
/**
- * True if the document is in strict mode
- * @type Boolean
+ * @property {Boolean} isStrict
+ * True if the document is in strict mode
*/
isStrict: false,
/**
* A "hybrid" property, can be either accessed as a method call, i.e:
- * <pre><code>
- * if (Ext.browser.is('IE')) { ... }
- * </code></pre>
+ *
+ * if (Ext.browser.is('IE')) { ... }
*
* or as an object with boolean properties, i.e:
- * <pre><code>
- * if (Ext.browser.is.IE) { ... }
- * </code></pre>
+ *
+ * if (Ext.browser.is.IE) { ... }
*
* Versions can be conveniently checked as well. For example:
- * <pre><code>
- * if (Ext.browser.is.IE6) { ... } // Equivalent to (Ext.browser.is.IE && Ext.browser.version.equals(6))
- * </code></pre>
+ *
+ * if (Ext.browser.is.IE6) { ... } // Equivalent to (Ext.browser.is.IE && Ext.browser.version.equals(6))
*
* 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.
@@ -108,28 +101,28 @@ Ext.define('Ext.env.Browser', {
is: Ext.emptyFn,
/**
- * Read-only - the full name of the current browser
+ * @property {String} name
+ * Read-only - the full name of the current browser
* Possible values are: IE, Firefox, Safari, Chrome, Opera and Other
- * @type String
*/
name: null,
/**
- * Read-only, refer to {@link Ext.Version}
- * @type Ext.Version
+ * @property {Ext.Version} version
+ * Read-only, refer to {@link Ext.Version}
*/
version: null,
/**
- * Read-only - the full name of the current browser's engine
+ * @property {String} engineName
+ * Read-only - the full name of the current browser's engine
* Possible values are: WebKit, Gecko, Presto, Trident and Other
- * @type String
*/
engineName: null,
/**
- * Read-only, refer to {@link Ext.Version}
- * @type Ext.Version
+ * @property {String} engineVersion
+ * Read-only, refer to {@link Ext.Version}
*/
engineVersion: null,
@@ -188,6 +181,11 @@ Ext.define('Ext.env.Browser', {
}, function() {
+ /**
+ * @property {Ext.env.Browser} browser
+ * @member Ext
+ * Global convenient instance of {@link Ext.env.Browser}.
+ */
Ext.browser = new Ext.env.Browser();
});