MODSERIAL
Fork of MODSERIAL by
Diff: MODSERIAL.h
- Revision:
- 32:f42def64c4ee
- Parent:
- 31:b90b20f78f04
diff -r b90b20f78f04 -r f42def64c4ee MODSERIAL.h --- a/MODSERIAL.h Fri Oct 11 18:31:01 2013 +0000 +++ b/MODSERIAL.h Sat Oct 12 09:53:06 2013 +0000 @@ -734,7 +734,19 @@ * * Redirect a stream to this MODSERIAL object * - * Important: A name parameter must have been added when creating the MODSERIAL object + * Important: A name parameter must have been added when creating the MODSERIAL object: + * + * @code + * #include "MODSERIAL.h" + * ... + * MODSERIAL pc(USBTX, USBRX, "modser"); + * + * int main() { + * pc.claim() // capture <stdout> + * pc.printf("Uses the MODSERIAL library\r\n"); + * printf("So does this!\r\n"); + * } + * @endcode * * @ingroup API * @param FILE *stream The stream to redirect (default = stdout)