uni-t-dmm: Add Tecpel DMM-8061 support.

[libsigrok.git] / input / input.c

diff --git a/input/input.c b/input/input.c
index 7fcd6502082a2e4e92ea64a0b91abc6e4fb13dbc..fa0bf438195a933b8860b5e5560ce37aaf26ef94 100644 (file)
--- a/input/input.c
+++ b/input/input.c
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
  *
@@ -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.
+ *
  * @{
  */