doxygen: Add more output format docs.

[libsigrok.git] / output / output.c

diff --git a/output/output.c b/output/output.c
index 6631855159444330beafa9364fe7cd797f18bebf..39dfc7dd926262d853bfd4579b4c818224d85867 100644 (file)
--- a/output/output.c
+++ b/output/output.c
@@ -17,9 +17,38 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrok.h"
-#include "sigrok-internal.h"
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Output file/data format handling.
+ */
+
+/**
+ * @defgroup grp_output Output formats
+ *
+ * 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.
+ *
+ * @{
+ */
+
+/** @cond PRIVATE */
 extern SR_PRIV struct sr_output_format output_text_bits;
 extern SR_PRIV struct sr_output_format output_text_hex;
 extern SR_PRIV struct sr_output_format output_text_ascii;
@@ -29,8 +58,9 @@ 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_analog_bits; */
+extern SR_PRIV struct sr_output_format output_analog;
 /* extern SR_PRIV struct sr_output_format output_analog_gnuplot; */
+/* @endcond */
 
 static struct sr_output_format *output_module_list[] = {
        &output_text_bits,
@@ -42,7 +72,7 @@ static struct sr_output_format *output_module_list[] = {
        &output_gnuplot,
        &output_chronovu_la8,
        &output_csv,
-       /* &output_analog_bits, */
+       &output_analog,
        /* &output_analog_gnuplot, */
        NULL,
 };
@@ -51,3 +81,5 @@ SR_API struct sr_output_format **sr_output_list(void)
 {
        return output_module_list;
 }
+
+/** @} */