doxygen2jsdoc: add custom typemap file
authorBrendan Le Foll <brendan.le.foll@intel.com>
Mon, 1 Jun 2015 14:23:28 +0000 (15:23 +0100)
committerBrendan Le Foll <brendan.le.foll@intel.com>
Mon, 1 Jun 2015 14:24:23 +0000 (15:24 +0100)
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
src/javascript/doxygen2jsdoc_custom.json [new file with mode: 0644]

diff --git a/src/javascript/doxygen2jsdoc_custom.json b/src/javascript/doxygen2jsdoc_custom.json
new file mode 100644 (file)
index 0000000..e5a2af6
--- /dev/null
@@ -0,0 +1,77 @@
+{
+  "Uart": {
+    "read": {
+      "description": "Read length bytes from the device",
+      "params": {
+        "length": {
+          "type": "Number",
+          "description": "Size of read in bytes to make"
+        }
+      },
+      "return": {
+        "type": "Buffer",
+        "description": "Data read"
+      }
+    },
+    "write": {
+      "description": "Write length bytes to the device",
+      "params": {
+        "length": {
+          "type": "Number",
+          "description": "Size of buffer to send"
+        }
+      },
+      "return": {
+        "type": "mraa_result_t",
+        "description": "Result of operation"
+      }
+    }
+  },
+  "I2c": {
+    "read": {
+      "description": "Read length bytes from the bus",
+      "params": {
+        "length": {
+          "type": "Number",
+          "description": "Size of read in bytes to make"
+        }
+      },
+      "return": {
+        "type": "Buffer",
+        "description": "Data read"
+      }
+    },
+    "write": {
+      "description": "Write length bytes to the bus, the first byte in the Buffer is the command/register to write",
+      "params": {
+        "length": {
+          "type": "Number",
+          "description": "Size of buffer to send"
+        }
+      },
+      "return": {
+        "type": "mraa_result_t",
+        "description": "Result of operation"
+      }
+    }
+  },
+  "Gpio": {
+    "isr": {
+      "description": "Sets a callback to be called when pin value changes",
+      "params": {
+        "mode": {
+          "type": "Edge",
+          "description": "The edge mode to set"
+        },
+        "func": {
+          "type": "Function",
+          "description": "Function to be called when interupt is triggered"
+        }
+      },
+      "return": {
+        "type": "mraa_result_t",
+        "description": "Result of operation"
+      }
+    }
+  }
+}