Raspberries/mraa
Private
Public Access
2
0
Fork 0
Code Activity

doxygen2jsdoc: add custom typemap file

Browse Source 
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2015-06-01 15:23:28 +01:00
parent 45b01b29de
commit d4968b6b81
1 changed files with 77 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
src/javascript/doxygen2jsdoc_custom.json Normal file
View File

@@ -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"
}
}
}
}