docs: example

nhn · Apr 5, 2016 · 9d7b471 · 9d7b471
1 parent 45ff629
commit 9d7b471
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -37,13 +37,13 @@ First, check whether app is installed or not.<br>
 ## History
 | Version | Description | Date | Developer |
 | ---- | ---- | ---- | ---- |
-| 1.0.2  | Fix ios timeout 2000ms | 2016.04 | NHN Ent. FE dev team <dl_javascript@nhnent.com> |
+| [1.0.2](https://nhnent.github.io/tui.component.m-app-loader/1.0.2/)  | [Fix ios timeout 2000ms](https://github.com/nhnent/tui.component.m-app-loader/releases/tag/1.0.2) | 2016.04 | NHN Ent. FE dev team <dl_javascript@nhnent.com> |
 | 1.0.1b  | Supporting intentURI using iframe (Android) | 2016.01 | NHN Ent. FE dev team <dl_javascript@nhnent.com> |
 | 1.0.1a  | Hotfix for supporting intentURI, universalLinks | 2015.10 | NHN Ent. FE dev team <dl_javascript@nhnent.com> |
-| <a href="https://nhnent.github.io/tui.component.m-app-loader/1.0.1/">1.0.1</a>  | Add static methods for detecting user agent | 2015.10 | NHN Ent. FE dev team <dl_javascript@nhnent.com> |
+| [1.0.1](https://nhnent.github.io/tui.component.m-app-loader/1.0.1/)  | Add static methods for detecting user agent | 2015.10 | NHN Ent. FE dev team <dl_javascript@nhnent.com> |
 | 1.0.0b | ios new window bug fix | 2015.08 | NHN Ent. FE dev team <dl_javascript@nhnent.com> |
 | 1.0.0a | defineNamespace apply | 2015.05 | NHN Ent. FE dev team <dl_javascript@nhnent.com> |
-| <a href="https://nhnent.github.io/tui.component.m-app-loader/1.0.0/">1.0.0</a> | release | 2015.04 | NHN Ent. FE dev team <dl_javascript@nhnent.com> |
+| [1.0.0](https://nhnent.github.io/tui.component.m-app-loader/1.0.0/) | release | 2015.04 | NHN Ent. FE dev team <dl_javascript@nhnent.com> |
 
 ## LICENSE
 [MIT LICENSE](LICENSE)
diff --git a/app-loader.js b/app-loader.js
diff --git a/samples/js/app-loader.js b/samples/js/app-loader.js
diff --git a/src/js/appLoader.js b/src/js/appLoader.js
@@ -22,8 +22,10 @@ var AppLoader = tui.util.defineClass(/** @lends AppLoader.prototype */{
          * Get first user agent (it will be browser name)
          * @api
          * @memberof AppLoader
-         * @function getUserAgent
-         * @return {string}
+         * @return {string} user agent
+         * @example
+         * var AppLoader = tui.component.m.AppLoader;
+         * var ua = AppLoader.getUserAgent(); // ex) 'safari'
          */
         getUserAgent: function() {
             return ad.userAgent();
@@ -33,8 +35,10 @@ var AppLoader = tui.util.defineClass(/** @lends AppLoader.prototype */{
          * Get all user agents by array
          * @api
          * @memberof AppLoader
-         * @function getUserAgents
          * @return {Array} agent strings
+         * @example
+         * var AppLoader = tui.component.m.AppLoader;
+         * var uas = AppLoader.getUserAgents(); // ex) ['safari']
          */
         getUserAgents: function() {
             return ad.userAgents();
@@ -44,8 +48,10 @@ var AppLoader = tui.util.defineClass(/** @lends AppLoader.prototype */{
          * Get OS
          * @api
          * @memberof AppLoader
-         * @function getOS
-         * @return {string}
+         * @return {string} os
+         * @example
+         * var AppLoader = tui.component.m.AppLoader;
+         * var os = AppLoader.getOS(); //  'iOS' or 'AndroidOS'
          */
         getOS: function() {
             return ad.getOS();
@@ -55,7 +61,7 @@ var AppLoader = tui.util.defineClass(/** @lends AppLoader.prototype */{
          * Get version
          * @api
          * @memberof AppLoader
-         * @function getVersion
+         * @param {string} type - os type
          * @return {number|string} version
          * @example
          *  getVersion('IOS');
@@ -212,6 +218,7 @@ var AppLoader = tui.util.defineClass(/** @lends AppLoader.prototype */{
 
     /**
      * Call app
+     * @api
      * @param {object} options The option for app
      *  @param {object} options.ios IOS app information
      *  @param {object} options.android Android information
@@ -232,14 +239,14 @@ var AppLoader = tui.util.defineClass(/** @lends AppLoader.prototype */{
      *      android: {
      *          intentURI: 'intent://home#Intent;scheme=fecheck;package=com.fecheck;end' // android intent uri
      *      },
-     *      timerSet: {
-     *          ios: 2000,
-     *          android: 1000
+     *      timerSet: { // optional values
+     *          ios: 2000, // default: 2000
+     *          android: 1000 // default: 800
      *      },
-     *      notFoundCallback: function() {
+     *      notFoundCallback: function() { // if not installed
      *          alert('not found');
      *      },
-     *      etcCallback: function() {
+     *      etcCallback: function() { // if not mobile
      *          alert('etc');
      *      }
      * });