Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.
This commit is contained in:
parent
2073b96d82
commit
a8b66f318d
109 changed files with 357 additions and 318 deletions
|
@ -50,7 +50,7 @@
|
|||
* The following files must be built with any user project that uses this module:
|
||||
* - None
|
||||
*
|
||||
* \section Module Description
|
||||
* \section Sec_ModDescription Module Description
|
||||
* Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
|
||||
* It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
|
||||
* actions can be taken.
|
||||
|
@ -60,7 +60,10 @@
|
|||
*
|
||||
* For possible BOARD makefile values, see \ref Group_BoardTypes.
|
||||
*
|
||||
* <b>Example Usage:</b>
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the button driver before first use
|
||||
* Buttons_Init();
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue