Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.

This commit is contained in:
Dean Camera 2010-12-26 14:55:26 +00:00
parent 2073b96d82
commit a8b66f318d
109 changed files with 357 additions and 318 deletions

View file

@ -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 LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It
* provides an interface to configure, test and change the status of all the board LEDs.
*
@ -68,7 +68,10 @@
* compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)
* which contains only stub functions and defines no LEDs.
*
* <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 board LED driver before first use
* LEDs_Init();