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
|
@ -47,7 +47,7 @@
|
|||
* The following files must be built with any user project that uses this module:
|
||||
* - None
|
||||
*
|
||||
* \section Module Description
|
||||
* \section Sec_ModDescription Module Description
|
||||
* Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of
|
||||
* different sizes to suit different needs.
|
||||
*
|
||||
|
@ -56,7 +56,10 @@
|
|||
* or deletions) must not overlap. If there is possibility of two or more of the same kind of
|
||||
* operating occuring at the same point in time, atomic (mutex) locking should be used.
|
||||
*
|
||||
* <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
|
||||
* // Create the buffer structure and its underlying storage array
|
||||
* RingBuff_t Buffer;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue