From: Uwe Hermann <redacted>
Date: Sun, 18 Jan 2015 15:02:54 +0000 (+0100)
Subject: sr_input_new(): Add missing @param comment.
X-Git-Tag: libsigrok-0.4.0~676
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=7a54232ba06b0715e4c98a913d1b316c8c521c2c;p=libsigrok.git

sr_input_new(): Add missing @param comment.

This fixes a Doxygen warning:

  src/input/input.c:209: warning: The following parameters of sr_input_new(const struct sr_input_module *imod, GHashTable *options) are not documented:
    parameter 'imod'
---

diff --git a/src/input/input.c b/src/input/input.c
index 3c7fd516..52924813 100644
--- a/src/input/input.c
+++ b/src/input/input.c
@@ -210,6 +210,7 @@ SR_API void sr_input_options_free(const struct sr_option **options)
  * This function is used when a client wants to use a specific input
  * module to parse a stream. No effort is made to identify the format.
  *
+ * @param imod The input module to use. Must not be NULL.
  * @param options GHashTable consisting of keys corresponding with
  * the module options \c id field. The values should be GVariant
  * pointers with sunk references, of the same GVariantType as the option's