マニュアル整備

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

diff --git a/misc/mbedJS/mbddJS.API/mbedJS/mbed.PortIn.js b/misc/mbedJS/mbddJS.API/mbedJS/mbed.PortIn.js
index 8c8d61f..8fb8f34 100644 (file)
--- a/misc/mbedJS/mbddJS.API/mbedJS/mbed.PortIn.js
+++ b/misc/mbedJS/mbddJS.API/mbedJS/mbed.PortIn.js
@@ -1,11 +1,14 @@
+/**\r
+ * @fileOverview PortInクラスを定義します。\r
+ */\r
 (function(){\r
 var NS=mbedJS;\r
 var MI=MiMicJS;\r
 \r
 /**\r
- * @name mbedJS.PortIn\r
  * PortInクラスです。\r
  * <a href="https://mbed.org/handbook/PortIn">mbed::PortIn</a>と同等の機能を持ちます。\r
+ * @name mbedJS.PortIn\r
  * @constructor\r
  * @param {mbedJS.Mcu} i_mcu\r
  * インスタンスをバインドするMCUオブジェクトです。\r
@@ -41,7 +44,42 @@ var MI=MiMicJS;
  * Generatorを指定した場合、コールバック関数の引数はyiledの戻り値として取得できます。\r
  * <p>\r
  * @return {mbedJS.PortIn}\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.PortIn(mcu,[mbedJS.PortName.Port0,0xffffffff],{\r
+ *     onNew:function(){\r
+ *       log("[PASS]onNew");\r
+ *       pin.read();\r
+ *     },\r
+ *     onRead:function(v)\r
+ *     {\r
+ *       log("[PASS]read:"+v);\r
+ *       mcu.close();\r
+ *     }});\r
+ *   },\r
+ *   onClose:function(){\r
+ *     log("[PASS]onClose");\r
+ *   },\r
+ *   onError:function(){\r
+ *     alert("Error");\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 port=new mbedJS.PortIn(mcu,[mbedJS.PortName.Port0,0xffffffff],g);\r
+ *   yield port.waitForNew();\r
+ *   var v=yield port.read();\r
+ *   yield mcu.close();\r
+ * }catch(e){\r
+ *   mcu.shutdown();\r
+ * }\r
+ * }();\r
+ * g.next();\r
  */\r
 var CLASS=function PortIn(i_mcu,i_params,i_handler)\r
 {\r
@@ -84,10 +122,10 @@ CLASS.prototype=
        /** @private リモートインスタンスのオブジェクトIDです。*/\r
        _oid:null,\r
        /**\r
-        * @name mbedJS.PortIn#waitForNew\r
-        * @function\r
         * Generatorモードのときに使用する関数です。\r
         * Generatorモードの時は、yieldと併用してnew PortIn()の完了を待ちます。\r
+        * @name mbedJS.PortIn#waitForNew\r
+        * @function\r
         */\r
        waitForNew:function PortIn_waitForNew()\r
        {\r
@@ -99,14 +137,15 @@ CLASS.prototype=
                }\r
        },\r
        /**\r
-        * @name mbedJS.PortIn#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.PortIn#read\r
+        * @function\r
+        * @return　{int}\r
+        * Callbackモードの時はRPCメソッドのインデクスを返します。\r
+        * @return　{int}\r
+        * Generatorモードの時はポートの値を返します。\r
         */\r
        read:function PortIn_read()\r
        {\r