マニュアル整備

[mimic/MiMicSDK.git] / misc / mbedJS / mbddJS.API / mbedJS / mbed.BusIn.js

diff --git a/misc/mbedJS/mbddJS.API/mbedJS/mbed.BusIn.js b/misc/mbedJS/mbddJS.API/mbedJS/mbed.BusIn.js
index 3fe23f5..be1bd69 100644 (file)
--- a/misc/mbedJS/mbddJS.API/mbedJS/mbed.BusIn.js
+++ b/misc/mbedJS/mbddJS.API/mbedJS/mbed.BusIn.js
@@ -1,11 +1,14 @@
+/**\r
+ * @fileOverview BusInクラスを定義します。\r
+ */\r
 (function(){\r
 var NS=mbedJS;\r
 var MI=MiMicJS;\r
 \r
 /**\r
- * @name mbedJS.BusIn\r
  * BusInクラスです。\r
  * <a href="https://mbed.org/handbook/BusIn">mbed::BusIn</a>と同等の機能を持ちます。\r
+ * @name mbedJS.BusIn\r
  * @constructor\r
  * @param {mbedJS.Mcu} i_mcu\r
  * インスタンスをバインドするMCUオブジェクトです。\r
@@ -33,7 +36,41 @@ var MI=MiMicJS;
  * Generatorを指定した場合、コールバック関数の引数はyiledの戻り値として取得できます。\r
  * <p>\r
  * @return {mbedJS.BusIn}\r
- * @example\r
+ * @example //Callback\r
+ * var mcu=new mbedJS.Mcu("ws://192.168.128.39/rpc/",\r
+ * {\r
+ *   onNew:function(){\r
+ *     var pin=new mbedJS.BusIn(mcu,[mbedJS.PinName.P0_21,mbedJS.PinName.P0_22],{\r
+ *     onNew:function(){\r
+ *       pin.read();\r
+ *     },\r
+ *     onRead:function(v)\r
+ *     {\r
+ *       pin.mode(mbedJS.PinMode.PullDown);\r
+ *     },\r
+ *     onMode:function(v){\r
+ *       mcu.close();\r
+ *     }});\r
+ *   },\r
+ *   onClose:function(){\r
+ *   },\r
+ *   onError:function(){\r
+ *   }\r
+ * });\r
+ * @example //Generator\r
+ * var g=function*(){\r
+ * try{\r
+ *   var mcu=new mbedJS.Mcu("ws://192.168.128.39/rpc/",g);\r
+ *   yield mcu.waitForNew();\r
+ *   var bus=new mbedJS.BusIn(mcu,[mbedJS.PinName.P0_21,mbedJS.PinName.P0_22],g);\r
+ *   yield bus.waitForNew();\r
+ *   var v=yield bus.read();\r
+ *   v=yield bus.mode(mbedJS.PinMode.PullUp);\r
+ *   yield mcu.close();\r
+ * }catch(e){\r
+ *   mcu.shutdown();\r
+ * }}();\r
+ * g.next();\r
  */\r
 var CLASS=function BusIn(i_mcu,i_params,i_handler)\r
 {\r
@@ -83,10 +120,10 @@ CLASS.prototype=
        /** @private リモートインスタンスのオブジェクトIDです。*/\r
        _oid:null,\r
        /**\r
-        * @name mbedJS.BusIn#waitForNew\r
-        * @function\r
         * Generatorモードのときに使用する関数です。\r
         * Generatorモードの時は、yieldと併用してnew BusIn()の完了を待ちます。\r
+        * @name mbedJS.BusIn#waitForNew\r
+        * @function\r
         */\r
        waitForNew:function BusIn_waitForNew()\r
        {\r
@@ -98,14 +135,15 @@ CLASS.prototype=
                }\r
        },\r
        /**\r
-        * @name mbedJS.BusIn#read\r
-        * @function\r
         * ピンから値を読み込みます。\r
         * 関数の完了時にonReadイベントが発生します。\r
         * Generatorモードの時は、yieldと併用して完了を待機できます。\r
-        * @return　{int|int}\r
-        * <p>Callbackモードの時はRPCメソッドのインデクスを返します。</p>\r
-        * <p>Generatorモードの時はピンの値を返します。</p>\r
+        * @name mbedJS.BusIn#read\r
+        * @function\r
+        * @return　{int}\r
+        * Callbackモードの時はRPCメソッドのインデクスを返します。\r
+        * @return　{int}\r
+        * Generatorモードの時はピンの値を返します。\r
         */\r
        read:function BusIn_read()\r
        {\r
@@ -127,15 +165,15 @@ CLASS.prototype=
                }\r
        },\r
        /**\r
-        * @name mbedJS.BusIn#mode\r
-        * @function\r
         * ピンモードを設定します。\r
         * 関数の完了時にonModeイベントが発生します。\r
         * Generatorモードの時は、yieldと併用して完了を待機できます。\r
+        * @name mbedJS.BusIn#mode\r
+        * @function\r
         * @param {PinMode} i_value\r
         * PinModeの値です。\r
-        * @return　{int|none}\r
-        * <p>Callbackモードの時はRPCメソッドのインデクスを返します。</p>\r
+        * @return　{int}\r
+        * Callbackモードの時はRPCメソッドのインデクスを返します。\r
         */\r
        mode:function BusIn_mode(i_value)\r
        {\r