マニュアル整備

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

diff --git a/misc/mbedJS/mbddJS.API/mbedJS/mbed.types.js b/misc/mbedJS/mbddJS.API/mbedJS/mbed.types.js
index e76777a..98f893c 100644 (file)
--- a/misc/mbedJS/mbddJS.API/mbedJS/mbed.types.js
+++ b/misc/mbedJS/mbddJS.API/mbedJS/mbed.types.js
@@ -1,9 +1,24 @@
+/**\r
+ * @fileOverview mbedSDKの定数を定義します。\r
+ */\r
+\r
+/**\r
+ * mbedJSネームスペース\r
+ * @namespace\r
+ */\r
 var mbedJS={};\r
 (function(){\r
 var NS=mbedJS;\r
 /**\r
+ * mbedSDKのピン識別子です。ライブラリのピン名と一致します。次のピン名を使用できます。\r
+ * <ul>\r
+ * <li> LPC Pin Names(P0_0 - P4_31)\r
+ * <li> mbed DIP Pin Names(p5-p40)\r
+ * <li> Other mbed Pin Names(LED1-LED4,USBRX,USBTX)\r
+ * <li> Arch Pro Pin Names(D0-D15,A0-A5,I2C_SCL,I2C_SDA)\r
+ * <li> NC\r
+ * </ul>\r
  * @name mbedJS.PinName\r
- * mbedSDKのピン識別子です。ライブラリのピン名と一致します。\r
  */\r
 NS.PinName=function(){\r
        var B;\r
@@ -50,9 +65,10 @@ NS.PinName=function(){
        return D;\r
 }();\r
 /**\r
- * @name mbedJS.PinMode\r
  * ピンモード値です。\r
- * mbedSDKのピンモード値です。\r
+ * mbedSDKのピンモード値と同一です。<br/>\r
+ * (PullUp|PullDown|PullNone|OpenDrain|PullDefault)\r
+ * @name mbedJS.PinMode\r
  */\r
 NS.PinMode={\r
        PullUp:         0x00010000,\r
@@ -61,9 +77,10 @@ NS.PinMode={
        OpenDrain:      0x00010003,\r
        PullDefault:0x00010004};\r
 /**\r
- * @name mbed.JS.PinName\r
  * ポート識別子です。\r
- * mbedSDKのポート名と同一です。\r
+ * mbedSDKのポート名と同一です。<br/>\r
+ * (Port0 - Port4)\r
+ * @name mbedJS.PortName\r
  */\r
 NS.PortName={\r
        Port0:  0x00010000,\r