Skip to content

Commit f0b7a14

Browse files
add missing srldrvce documentation
Signed-off-by: mateoconlechuga <matthewwaltzis@gmail.com>
1 parent 5b17470 commit f0b7a14

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/libraries/srldrvce.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _srldrvce_h:
2+
3+
srldrvce.h
4+
==========
5+
6+
.. code-block:: c
7+
8+
#include <srldrvce.h>
9+
10+
The :code:`srldrvce` library adds support for reading and writing serial devices in host mode, as well as emulating a serial device in device mode.
11+
This library is built on top of the :code:`usbdrvce` library - data that is not serial in nature such as pictures, video, and audio may be more suited to using the :code:`usbdrvce` library directly.
12+
13+
Currently this library is a work-in-progress, so some functionality may not behave as expected.
14+
This means that future library versions may create backwards-incompatible changes - however the likelihood of this is rather low as long as you use the library in a reasonable manner.
15+
16+
.. tip::
17+
18+
Be sure to look at the provided examples for guidance on how to use this library correctly.
19+
Hopefully in the future this page will include more documentation as the library becomes more complete.
20+
21+
.. contents:: :local:
22+
:depth: 3
23+
24+
API Documentation
25+
-----------------
26+
27+
.. doxygenfile:: srldrvce.h
28+
:project: CE C/C++ Toolchain

0 commit comments

Comments
 (0)