doxygen: Add more input format docs.

[libsigrok.git] / input / input.c

diff --git a/input/input.c b/input/input.c
index fd51a874ba9faf0701f4ff04d60a032aa3f413d6..e876dfcaa838f9cc703b608c9122d4fedb59a1c9 100644 (file)
--- a/input/input.c
+++ b/input/input.c
@@ -31,16 +31,35 @@
  *
  * Input file/data format handling.
  *
+ * libsigrok can process acquisition data in several different ways.
+ * Aside from acquiring data from a hardware device, it can also take it from
+ * a file in various formats (binary, CSV, VCD, and so on).
+ *
+ * Like everything in libsigrok that handles data, processing is done in a
+ * streaming manner -- input should be supplied to libsigrok a chunk at a time.
+ * This way anything that processes data can do so in real time, without the
+ * user having to wait for the whole thing to be finished.
+ *
+ * Every input module is "pluggable", meaning it's handled as being separate
+ * from the main libsigrok, but linked in to it statically. To keep things
+ * modular and separate like this, functions within an input module should be
+ * declared static, with only the respective 'struct sr_input_format' being
+ * exported for use into the wider libsigrok namespace.
+ *
  * @{
  */
 
 /** @cond PRIVATE */
 extern SR_PRIV struct sr_input_format input_chronovu_la8;
 extern SR_PRIV struct sr_input_format input_binary;
+extern SR_PRIV struct sr_input_format input_vcd;
+extern SR_PRIV struct sr_input_format input_wav;
 /* @endcond */
 
 static struct sr_input_format *input_module_list[] = {
+       &input_vcd,
        &input_chronovu_la8,
+       &input_wav,
        /* This one has to be last, because it will take any input. */
        &input_binary,
        NULL,