aboutsummaryrefslogtreecommitdiffstats
path: root/libusb/libusb.h
diff options
context:
space:
mode:
authorPete Batard <pete@akeo.ie>2012-09-16 16:19:54 +0100
committerPete Batard <pete@akeo.ie>2012-09-16 17:23:48 +0100
commit517f9827c469ec8ef793a9a20a50f1fcc0f53079 (patch)
tree8d0c2a8be60b6f0fc98e22e6c355560df719783c /libusb/libusb.h
parentc9ecb7255b29b13f3b5a7a9de4c587f48402885c (diff)
downloadandroid_external_libusbx-517f9827c469ec8ef793a9a20a50f1fcc0f53079.tar.gz
android_external_libusbx-517f9827c469ec8ef793a9a20a50f1fcc0f53079.tar.bz2
android_external_libusbx-517f9827c469ec8ef793a9a20a50f1fcc0f53079.zip
Doc: Fix doxygen warnings and issues
* Remove obsolete tags * Use QUIET = yes to make issues more prominent * Fix code display for LIBUSBX_API_VERSION and missing parameter documentation for libusb_get_port_path() * Most of the above suggested by Ludovic Rousseau
Diffstat (limited to 'libusb/libusb.h')
-rw-r--r--libusb/libusb.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/libusb/libusb.h b/libusb/libusb.h
index fd1a210..7972ef9 100644
--- a/libusb/libusb.h
+++ b/libusb/libusb.h
@@ -118,9 +118,11 @@ typedef unsigned __int32 uint32_t;
* libusbx applications may want to detect at compilation time.
*
* The macro is typically used in an application as follows:
+ * \code
* #if defined(LIBUSBX_API_VERSION) && (LIBUSBX_API_VERSION >= 0x01001234)
* // Use one of the newer features from the libusbx API
* #endif
+ * \endcode
*
* Another feature of LIBUSBX_API_VERSION is that it can be used to detect
* whether you are compiling against the libusb or the libusbx library.