doxygen: Add more output format docs.

[libsigrok.git] / output / output.c

diff --git a/output/output.c b/output/output.c
index 91fdf3884d52c0e134a86526cf51d962c5c82226..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.
+ *
  * @{
  */