マニュアル整備

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

diff --git a/misc/mbedJS/mbddJS.API/mbedJS/mbed.PortOut.js b/misc/mbedJS/mbddJS.API/mbedJS/mbed.PortOut.js
index a4357ef..ce8d51e 100644 (file)
--- a/misc/mbedJS/mbddJS.API/mbedJS/mbed.PortOut.js
+++ b/misc/mbedJS/mbddJS.API/mbedJS/mbed.PortOut.js
@@ -1,11 +1,14 @@
+/**\r
+ * @fileOverview PortOutクラスを定義します。\r
+ */\r
 (function(){\r
 var NS=mbedJS;\r
 var MI=MiMicJS;\r
 \r
 /**\r
- * @name mbedJS.PortOut\r
  * PortOutクラスです。\r
  * <a href="https://mbed.org/handbook/PortOut">mbed::PortOut</a>と同等の機能を持ちます。\r
+ * @name mbedJS.PortOut\r
  * @constructor\r
  * @param {mbedJS.Mcu} i_mcu\r
  * インスタンスをバインドするMCUオブジェクトです。\r
@@ -44,7 +47,43 @@ var MI=MiMicJS;
  * Generatorを指定した場合、コールバック関数の引数はyiledの戻り値として取得できます。\r
  * <p>\r
  * @return {mbedJS.PortOut}\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.PortOut(mcu,[mbedJS.PortName.Port0,0xffffffff],{\r
+ *     onNew:function(){\r
+ *       pin.write(1234);\r
+ *     },\r
+ *     onWrite:function()\r
+ *     {\r
+ *       pin.read();\r
+ *     },      \r
+ *     onRead:function(v)\r
+ *     {\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 port=new mbedJS.PortOut(mcu,{port:mbedJS.PortName.Port0,mask:0xffffffff},g);\r
+ *   yield port.waitForNew();\r
+ *   yield port.write(5678);\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 PortOut(i_mcu,i_params,i_handler)\r
 {\r
@@ -87,10 +126,10 @@ CLASS.prototype=
        /** @private リモートインスタンスのオブジェクトIDです。*/\r
        _oid:null,\r
        /**\r
-        * @name mbedJS.PortOut#waitForNew\r
-        * @function\r
         * Generatorモードのときに使用する関数です。\r
         * Generatorモードの時は、yieldと併用してnew PortOut()の完了を待ちます。\r
+        * @name mbedJS.PortOut#waitForNew\r
+        * @function\r
         */\r
        waitForNew:function DigitalOut_waitForNew()\r
        {\r
@@ -102,15 +141,14 @@ CLASS.prototype=
                }\r
        },\r
        /**\r
-        * @name mbedJS.PortOut#write\r
-        * @function\r
         * ポートへ値を出力します。\r
         * 関数の完了時にonWriteイベントが発生します。\r
         * Generatorモードの時は、yieldと併用して完了を待機できます。\r
+        * @name mbedJS.PortOut#write\r
+        * @function\r
         * @param {int} i_value\r
-        * @return {int|none}\r
-        * <p>Callbackモードの時はRPCメソッドのインデクスを返します。</p>\r
-        * <p>Generatorモードの時は戻り値はありません。</p>\r
+        * @return {int}\r
+        * Callbackモードの時はRPCメソッドのインデクスを返します。\r
         */\r
        write:function PortOut_write(i_value)\r
        {\r
@@ -130,14 +168,15 @@ CLASS.prototype=
                }\r
        },\r
        /**\r
-        * @name mbedJS.PortOut#write\r
-        * @function\r
         * ポートから値を読み込みます。\r
         * 関数の完了時にonReadイベントが発生します。\r
         * Generatorモードの時は、yieldと併用して完了を待機できます。\r
-        * @return　{int|int}\r
-        * <p>Callbackモードの時はRPCメソッドのインデクスを返します。</p>\r
-        * <p>Generatorモードの時はポートの値を返します。</p>\r
+        * @name mbedJS.PortOut#write\r
+        * @function\r
+        * @return　{int}\r
+        * Callbackモードの時はRPCメソッドのインデクスを返します。\r
+        * @return　{int}\r
+        * Generatorモードの時はポートの値を返します。\r
         */\r
        read:function PortOut_read()\r
        {\r