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

doc: cleanup internal documentation and naming

Browse Source 
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2014-10-03 10:18:13 +01:00
parent 3898182743
commit c5c5c9b700
6 changed files with 157 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/platform-hooks.md
View File

@@ -1,16 +1,25 @@
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.
platform-hooks {#hooks}
==============
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
###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.
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
Any functionality defined here will be performed when the main function is called.
Any functionality defined here will be performed when the main function is
called.
###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.
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