Added basic driver example use code to the library documentation.

Made the USARTStream global public and documented in the SerialStream module, allowing for the serial USART stream to be accessed via its handle rather than via the implicit stdout and stdin streams.
This commit is contained in:
Dean Camera 2010-12-26 14:25:34 +00:00
parent 39ac72f2d1
commit 2073b96d82
18 changed files with 266 additions and 23 deletions

View file

@ -56,7 +56,7 @@
* 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.
*
* Example Usage:
* <b>Example Usage:</b>
* \code
* // Create the buffer structure and its underlying storage array
* RingBuff_t Buffer;
@ -76,7 +76,7 @@
* uint16_t BufferCount = RingBuffer_GetCount(&Buffer);
*
* // Printer stored data length
* printf("Buffer Length: %d, Buffer Data:\r\n", BufferCount);
* printf("Buffer Length: %d, Buffer Data: \r\n", BufferCount);
*
* // Print contents of the buffer one character at a time
* while (BufferCount--)