From eaa395d99c36ebc75eca2a2af97387b33585365e Mon Sep 17 00:00:00 2001 From: Thomas Ingleby Date: Fri, 27 Jun 2014 15:46:51 +0100 Subject: [PATCH] doc: fix formatting on platform-hooks Signed-off-by: Thomas Ingleby --- docs/platform-hooks.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/platform-hooks.md b/docs/platform-hooks.md index c66d9bf..2b920c6 100644 --- a/docs/platform-hooks.md +++ b/docs/platform-hooks.md @@ -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)