]> sigrok.org Git - libsigrok.git/commitdiff
sr_input_new(): Add missing @param comment.
authorUwe Hermann <redacted>
Sun, 18 Jan 2015 15:02:54 +0000 (16:02 +0100)
committerUwe Hermann <redacted>
Mon, 19 Jan 2015 07:47:40 +0000 (08:47 +0100)
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'

src/input/input.c

index 3c7fd516a309ea7e05aff2da1b3c16a592355d6a..5292481381404bc3540b289d4dbd5c5f08d607e8 100644 (file)
@@ -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