X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=input%2Finput.c;h=e876dfcaa838f9cc703b608c9122d4fedb59a1c9;hb=8368734386f3bce5c568258b830c002d2581dfc6;hp=7fcd6502082a2e4e92ea64a0b91abc6e4fb13dbc;hpb=1d36b4d27f737dfcd6e232bc9d9538bd64bf1afb;p=libsigrok.git

diff --git a/input/input.c b/input/input.c
index 7fcd6502..e876dfca 100644
--- a/input/input.c
+++ b/input/input.c
@@ -31,6 +31,21 @@
  *
  * 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.
+ *
  * @{
  */