doxygen: Add more output format docs.

[libsigrok.git] / output / output.c

diff --git a/output/output.c b/output/output.c
index d726ad934819f09829444b3f4036de781a5d75bb..39dfc7dd926262d853bfd4579b4c818224d85867 100644 (file)
--- a/output/output.c
+++ b/output/output.c
@@ -31,6 +31,20 @@
  *
  * Output file/data format handling.
  *
+ * libsigrok supports several output (file) formats, e.g. binary, VCD,
+ * gnuplot, and so on. It provides an output API that frontends can use.
+ * New output formats can be added/implemented in libsigrok without having
+ * to change the frontends at all.
+ *
+ * All output modules are fed data in a stream. Devices that can stream data
+ * into libsigrok live, instead of storing and then transferring the whole
+ * buffer, can thus generate output live.
+ *
+ * Output modules are responsible for allocating enough memory to store
+ * their own output, and passing a pointer to that memory (and length) of
+ * the allocated memory back to the caller. The caller is then expected to
+ * free this memory when finished with it.
+ *
  * @{
  */
 
@@ -44,7 +58,6 @@ extern SR_PRIV struct sr_output_format output_ols;
 extern SR_PRIV struct sr_output_format output_gnuplot;
 extern SR_PRIV struct sr_output_format output_chronovu_la8;
 extern SR_PRIV struct sr_output_format output_csv;
-extern SR_PRIV struct sr_output_format output_float;
 extern SR_PRIV struct sr_output_format output_analog;
 /* extern SR_PRIV struct sr_output_format output_analog_gnuplot; */
 /* @endcond */
@@ -59,7 +72,6 @@ static struct sr_output_format *output_module_list[] = {
        &output_gnuplot,
        &output_chronovu_la8,
        &output_csv,
-       &output_float,
        &output_analog,
        /* &output_analog_gnuplot, */
        NULL,