EMTime/libopencm3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

lm4f: Add doxygen documentation for the USB driver

Browse Source 
Add minimal documentation for the USB driver. The internal functions and
structs are excluded.

Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
This commit is contained in:
Alexandru Gagniuc
2013-05-15 17:07:48 -05:00
parent 2fda5282ab
commit ad048f7d5a
2 changed files with 54 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
include/libopencm3/lm4f/usb.h
View File

@@ -17,9 +17,27 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/** @defgroup usb_defines USB Controller
*
* @brief <b>Defined Constants and Types for the LM4F USB Controller</b>
*
* @ingroup LM4Fxx_defines
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2013 Alexandru Gagniuc <mr.nuke.me@gmail.com>
*
* @date 15 May 2013
*
* LGPL License Terms @ref lgpl_license
*/
#ifndef LIBOPENCM3_LM4F_USB_H
#define LIBOPENCM3_LM4F_USB_H
/**@{*/
#include <libopencm3/lm4f/memorymap.h>
#include <libopencm3/cm3/common.h>
@@ -364,5 +382,6 @@
/** Controller type */
#define USB_PP_TYPE_MASK (0x0F << 0)
/**@}*/
#endif /* LIBOPENCM3_LM4F_USB_H */