mraa: update to version 0.8.1

[contrib/mraa.git] / docs / platform-hooks.md

diff --git a/docs/platform-hooks.md b/docs/platform-hooks.md
index c66d9bf..5499dd7 100644 (file)
--- a/docs/platform-hooks.md
+++ b/docs/platform-hooks.md
@@ -1,21 +1,33 @@
-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}
+==============
 
-## Types of 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.
 
-** 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.
+##Types of Hooks
 
-** PRE **
-Any functionality defined here will be performed when the main function is called.
+###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.
 
-** 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.
+###PRE
+Any functionality defined here will be performed when the main function is
+called.
 
-## Hooks
-** gpio **
-* init (pre-post) - On RAW functions
-* mode (replace-pre-post)
-* dir (replace-pre-post)
-* write (pre-post)
-* use-mmaped (replace-pre-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)
+ * mode (replace-pre-post)
+ * dir (replace-pre-post)
+ * write (pre-post)
+ * use-mmaped (replace-pre-post)
+
+### I2C
+ * init (pre-post) - On RAW