build: Portability fixes.

[libsigrok.git] / input / input.c

diff --git a/input/input.c b/input/input.c
index 465d9bb2057f07ddf0bfdbe08baddbf6eb1d350c..d22b373467caa894e6ee4b7618b4819e461dd6aa 100644 (file)
--- a/input/input.c
+++ b/input/input.c
@@ -1,7 +1,7 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok 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,17 +17,60 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include <sigrok.h>
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
 
-extern struct sr_input_format input_binary;
+/**
+ * @file
+ *
+ * Input file/data format handling.
+ */
+
+/**
+ * @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_csv;
+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,
+       &input_csv,
        /* This one has to be last, because it will take any input. */
        &input_binary,
        NULL,
 };
 
-struct sr_input_format **sr_input_list(void)
+/** @since 0.1.0 */
+SR_API struct sr_input_format **sr_input_list(void)
 {
        return input_module_list;
 }
+
+/** @} */