From d4968b6b81ca224e3ec9029c7bc46b9cede0f928 Mon Sep 17 00:00:00 2001 From: Brendan Le Foll Date: Mon, 1 Jun 2015 15:23:28 +0100 Subject: [PATCH] doxygen2jsdoc: add custom typemap file Signed-off-by: Brendan Le Foll --- src/javascript/doxygen2jsdoc_custom.json | 77 ++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 src/javascript/doxygen2jsdoc_custom.json diff --git a/src/javascript/doxygen2jsdoc_custom.json b/src/javascript/doxygen2jsdoc_custom.json new file mode 100644 index 0000000..e5a2af6 --- /dev/null +++ b/src/javascript/doxygen2jsdoc_custom.json @@ -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" + } + } + } +} -- 2.7.4