From: Uwe Hermann <redacted>
Date: Sat, 6 Apr 2013 17:18:37 +0000 (+0200)
Subject: Doxygen: Fix a few warnings.
X-Git-Tag: dsupstream~234
X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=commitdiff_plain;h=ca0938c50b4bf5d010d6140f64542f8307d8ea17

Doxygen: Fix a few warnings.
---

diff --git a/device.c b/device.c
index 0aeb4159..5e1c8364 100644
--- 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.
diff --git a/filter.c b/filter.c
index 044737da..80c0d67a 100644
--- 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
diff --git a/hwdriver.c b/hwdriver.c
index c2e6cda1..5fe571bf 100644
--- a/hwdriver.c
+++ b/hwdriver.c
@@ -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.
diff --git a/libsigrok.h b/libsigrok.h
index 3d577ccc..41031fca 100644
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -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: