X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=input%2Finput.c;h=e876dfcaa838f9cc703b608c9122d4fedb59a1c9;hb=ec4063b83c9b8a0693b9837787306dd5405e076b;hp=bace6f96aa71317e8c7a6e53cd0af32855bc39bc;hpb=34e4813f2e8b75981ed92d625c5fd55146a35e66;p=libsigrok.git

diff --git a/input/input.c b/input/input.c
index bace6f96..e876dfca 100644
--- a/input/input.c
+++ b/input/input.c
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,19 +17,57 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include <sigrok.h>
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
 
-extern struct input_format input_binary;
+/**
+ * @file
+ *
+ * Input file/data format handling.
+ */
 
-struct input_format *input_module_list[] = {
+/**
+ * @defgroup grp_input Input formats
+ *
+ * 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 */
 
-	/* this one has to be last, because it will take any input */
+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,
 };
 
-struct input_format **input_list(void)
+SR_API struct sr_input_format **sr_input_list(void)
 {
-
 	return input_module_list;
 }
+
+/** @} */