From: Uwe Hermann <redacted>
Date: Tue, 8 May 2012 23:06:01 +0000 (+0200)
Subject: srd: Fix a few Doxygen errors.
X-Git-Tag: libsigrokdecode-0.1.1~120
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=29590b14fc508a0b951ea0b87e98f7741808bab0;p=libsigrokdecode.git

srd: Fix a few Doxygen errors.
---

diff --git a/controller.c b/controller.c
index f95f3d8..0d914c9 100644
--- a/controller.c
+++ b/controller.c
@@ -330,9 +330,9 @@ static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
  * it overwrites any probes that were already defined (if any).
  *
  * @param di Decoder instance.
- * @param probes A GHashTable of probes to set. Key is probe name, value is
- *               the probe number. Samples passed to this instance will be
- *               arranged in this order.
+ * @param new_probes A GHashTable of probes to set. Key is probe name, value is
+ *                   the probe number. Samples passed to this instance will be
+ *                   arranged in this order.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
@@ -402,7 +402,7 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
 /**
  * Create a new protocol decoder instance.
  *
- * @param id Decoder 'id' field.
+ * @param decoder_id Decoder 'id' field.
  * @param options GHashtable of options which override the defaults set in
  *                the decoder class.
  *
@@ -749,7 +749,7 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
  *
  * @param start_samplenum The sample number of the first sample in this chunk.
  * @param inbuf Pointer to sample data.
- * @param inbuf Length in bytes of the buffer.
+ * @param inbuflen Length in bytes of the buffer.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
diff --git a/decoder.c b/decoder.c
index 6290add..4cf4197 100644
--- a/decoder.c
+++ b/decoder.c
@@ -124,7 +124,7 @@ err_out:
 /**
  * Load a protocol decoder module into the embedded Python interpreter.
  *
- * @param name The module name to be loaded.
+ * @param module_name The module name to be loaded.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
diff --git a/util.c b/util.c
index 6dbeb2f..ed31e97 100644
--- a/util.c
+++ b/util.c
@@ -68,8 +68,8 @@ SRD_PRIV int py_attr_as_str(const PyObject *py_obj, const char *attr,
  * allocated char *.
  *
  * @param py_obj The dictionary to probe.
- * @param attr Key of the item to retrieve.
- * @param outstr ptr to char * storage to be filled in.
+ * @param key Key of the item to retrieve.
+ * @param outstr Pointer to char * storage to be filled in.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *         The 'outstr' argument points to a malloc()ed string upon success.