Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sys/usb: Add configurations to Doxygen configuration group #12873

Merged
merged 4 commits into from
Dec 5, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
usb: Fix VID/PID macros documentation
  • Loading branch information
leandrolanzieri committed Dec 4, 2019
commit d835c52a4b0497c987449833306a24a1f74425d5
15 changes: 13 additions & 2 deletions sys/include/usb.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,31 @@ extern "C" {

/**
* @brief USB peripheral device vendor ID
*
* @note You must provide your own VID/PID combination when manufacturing a
* device with USB.
*/
#ifndef USB_CONFIG_VID
#ifdef DOXYGEN
#define USB_CONFIG_VID
#else
#error Please supply your vendor ID by setting USB_CONFIG_VID
#endif
#endif

/**
* @brief USB peripheral device product ID
*
* You must provide your own VID/PID combination when manufacturing a device
* with USB
* @note You must provide your own VID/PID combination when manufacturing a
* device with USB.
*/
#ifndef USB_CONFIG_PID
#ifdef DOXYGEN
#define USB_CONFIG_PID
#else
#error Please supply your vendor ID by setting USB_CONFIG_PID
#endif
#endif

/**
* @brief USB peripheral manufacturer string
Expand Down