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

doc: fix formatting on platform-hooks

Browse Source 
Signed-off-by: Thomas Ingleby <thomas.c.ingleby@intel.com>
This commit is contained in:
Thomas Ingleby
2014-06-27 15:46:51 +01:00
parent d0ea43f8d1
commit eaa395d99c
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/platform-hooks.md
View File

@@ -1,21 +1,21 @@
Hooks can be defined per supported platform to allow for highly custom operations if needed.
This feature of MRAA should only be used by developers defining the board definitions, NOT an end user.
## Types of Hooks
##Types of Hooks
** REPLACE **
###REPLACE
Defining a replace function will entirely replace the associate function. This should only be done if your new function can handle everything the mraa function would normally.
** PRE **
###PRE
Any functionality defined here will be performed when the main function is called.
** POST **
###POST
Any functionality perfomed here is done just before the normal function returns. All post functions will have passed into them the return value that would normally be returned.
## Hooks
** gpio **
* init (pre-post) - On RAW functions
* mode (replace-pre-post)
* dir (replace-pre-post)
* write (pre-post)
* use-mmaped (replace-pre-post)
##Hooks
### GPIO
* init (pre-post) - On RAW functions
* mode (replace-pre-post)
* dir (replace-pre-post)
* write (pre-post)
* use-mmaped (replace-pre-post)