]> sigrok.org Git - libsigrok.git/commitdiff
Doxygen: Fix a few warnings.
authorUwe Hermann <redacted>
Sat, 6 Apr 2013 17:18:37 +0000 (19:18 +0200)
committerUwe Hermann <redacted>
Sat, 6 Apr 2013 17:25:23 +0000 (19:25 +0200)
device.c
filter.c
hwdriver.c
libsigrok.h

index 0aeb41595fc1522f3fd6aa5be1f403ad306a42a0..5e1c8364edb22dab1ca88a775332c00726cb3033 100644 (file)
--- a/device.c
+++ b/device.c
@@ -183,7 +183,7 @@ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
  *            If the device's 'driver' field is NULL (virtual device), this
  *            function will always return FALSE (virtual devices don't have
  *            a hardware capabilities list).
- * @param option The option that should be checked for support on the
+ * @param key The option that should be checked for support on the
  *            specified device.
  *
  * @return TRUE if the device has the specified option, FALSE otherwise.
index 044737dad8f197b2f7a478b25d4b7cbeaf5e1090..80c0d67afa5dab0635ff15c28333e08cb3687bd2 100644 (file)
--- a/filter.c
+++ b/filter.c
@@ -80,8 +80,8 @@
  *                     The requested unit size must be big enough to hold as
  *                     much data as is specified by the number of enabled
  *                     probes in 'probelist'.
- * @param probelist Pointer to a list of probe numbers, numbered starting
- *                  from 0. The list is terminated with -1.
+ * @param probe_array Pointer to a list of probe numbers, numbered starting
+ *                    from 0. The list is terminated with -1.
  * @param data_in Pointer to the input data buffer. Must not be NULL.
  * @param length_in The input data length (>= 1), in number of bytes.
  * @param data_out Variable which will point to the newly allocated buffer
index c2e6cda1dd9c8f569e2510ea518ecfa871b44096..5fe571bfb79656905cf2ff7473ffe321c99d6baa 100644 (file)
@@ -454,7 +454,7 @@ SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
 /**
  * Get information about a configuration key.
  *
- * @param opt The configuration key.
+ * @param key The configuration key.
  *
  * @return A pointer to a struct sr_config_info, or NULL if the key
  *         was not found.
index 3d577cccac2f93f0d14d9dcae795162170536e0b..41031fcab949d02d3ddbfc7b8e2d66f00c3cbabd 100644 (file)
@@ -36,7 +36,7 @@ extern "C" {
  * The public libsigrok header file to be used by frontends.
  *
  * This is the only file that libsigrok users (frontends) are supposed to
- * use and #include. There are other header files which get installed with
+ * use and \#include. There are other header files which get installed with
  * libsigrok, but those are not meant to be used directly by frontends.
  *
  * The correct way to get/use the libsigrok API functions is: