diff options
author | Pete Batard <pete@akeo.ie> | 2012-09-16 16:19:54 +0100 |
---|---|---|
committer | Pete Batard <pete@akeo.ie> | 2012-09-16 17:23:48 +0100 |
commit | 517f9827c469ec8ef793a9a20a50f1fcc0f53079 (patch) | |
tree | 8d0c2a8be60b6f0fc98e22e6c355560df719783c | |
parent | c9ecb7255b29b13f3b5a7a9de4c587f48402885c (diff) | |
download | libusb-517f9827c469ec8ef793a9a20a50f1fcc0f53079.tar.gz |
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
-rw-r--r-- | doc/doxygen.cfg.in | 14 | ||||
-rw-r--r-- | libusb/core.c | 1 | ||||
-rw-r--r-- | libusb/libusb.h | 2 | ||||
-rw-r--r-- | libusb/version_nano.h | 2 |
4 files changed, 5 insertions, 14 deletions
diff --git a/doc/doxygen.cfg.in b/doc/doxygen.cfg.in index 5fcd683..5bb13da 100644 --- a/doc/doxygen.cfg.in +++ b/doc/doxygen.cfg.in @@ -407,12 +407,6 @@ MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from the # version control system). Doxygen will invoke the program by executing (via @@ -430,7 +424,7 @@ FILE_VERSION_FILTER = # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. -QUIET = NO +QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank @@ -707,12 +701,6 @@ HTML_FOOTER = HTML_STYLESHEET = -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) diff --git a/libusb/core.c b/libusb/core.c index 097870f..e31adf2 100644 --- a/libusb/core.c +++ b/libusb/core.c @@ -674,6 +674,7 @@ uint8_t API_EXPORTED libusb_get_port_number(libusb_device *dev) /** \ingroup dev * Get the list of all port numbers from root for the specified device + * \param ctx the context to operate on, or NULL for the default context * \param dev a device * \param path the array that should contain the port numbers * \param path_len the maximum length of the array. As per the USB 3.0 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. diff --git a/libusb/version_nano.h b/libusb/version_nano.h index 47186e5..f7118f0 100644 --- a/libusb/version_nano.h +++ b/libusb/version_nano.h @@ -1 +1 @@ -#define LIBUSB_NANO 10570 +#define LIBUSB_NANO 10571 |