summaryrefslogtreecommitdiff
path: root/libusb/hotplug.c
diff options
context:
space:
mode:
authorChris Dickens <christopher.a.dickens@gmail.com>2016-02-24 01:07:20 -0800
committerChris Dickens <christopher.a.dickens@gmail.com>2016-02-24 01:07:20 -0800
commit7ee92df12adb8015451aaecfeccd7dd62cc2314e (patch)
tree69aa53a859edd88b6a79fa21fb2b9f02e35aba4d /libusb/hotplug.c
parent8a0c14372f98d56529556f18126a42fda2ab0137 (diff)
downloadlibusb-7ee92df12adb8015451aaecfeccd7dd62cc2314e.tar.gz
Misc: Prefix doxygen references in order to namespace libusb
This change add "libusb_" to every group and page definition (and updates all references accordingly) so that generated man pages are namespaced for libusb, thus avoiding possible conflict with other packages. Closes #131 Signed-off-by: Chris Dickens <christopher.a.dickens@gmail.com>
Diffstat (limited to 'libusb/hotplug.c')
-rw-r--r--libusb/hotplug.c8
1 files changed, 4 insertions, 4 deletions
diff --git a/libusb/hotplug.c b/libusb/hotplug.c
index 85d44af..5db8d0b 100644
--- a/libusb/hotplug.c
+++ b/libusb/hotplug.c
@@ -34,14 +34,14 @@
#include "hotplug.h"
/**
- * @defgroup hotplug Device hotplug event notification
+ * @defgroup libusb_hotplug Device hotplug event notification
* This page details how to use the libusb hotplug interface, where available.
*
* Be mindful that not all platforms currently implement hotplug notification and
* that you should first call on \ref libusb_has_capability() with parameter
* \ref LIBUSB_CAP_HAS_HOTPLUG to confirm that hotplug support is available.
*
- * \page hotplug Device hotplug event notification
+ * \page libusb_hotplug Device hotplug event notification
*
* \section hotplug_intro Introduction
*
@@ -83,8 +83,8 @@
* safe to call any libusb function that takes a libusb_device. It also safe to
* open a device and submit asynchronous transfers. However, most other functions
* that take a libusb_device_handle are <b>not</b> safe to call. Examples of such
- * functions are any of the \ref syncio "synchronous API" functions or the blocking
- * functions that retrieve various \ref desc "USB descriptors". These functions must
+ * functions are any of the \ref libusb_syncio "synchronous API" functions or the blocking
+ * functions that retrieve various \ref libusb_desc "USB descriptors". These functions must
* be used outside of the context of the hotplug callback.
*
* When handling a LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT event the only safe function