From: Uwe Hermann <redacted>
Date: Tue, 8 Feb 2011 23:01:02 +0000 (+0100)
Subject: sigrokdecode.h: More doxygen-friendly comments.
X-Git-Tag: libsigrokdecode-0.1.0~286
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=775dda7af58ad9a6bb45ef05634bed59497bb305;p=libsigrokdecode.git

sigrokdecode.h: More doxygen-friendly comments.
---

diff --git a/sigrokdecode.h b/sigrokdecode.h
index ccfb6c1..b941c9f 100644
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -46,30 +46,52 @@ extern "C" {
  * or reused for different #defines later. You can only add new #defines and
  * return codes, but never remove or redefine existing ones.
  */
-#define SRD_OK			 0 /* No error */
-#define SRD_ERR			-1 /* Generic/unspecified error */
-#define SRD_ERR_MALLOC		-2 /* Malloc/calloc/realloc error */
-#define SRD_ERR_ARGS		-3 /* Function argument error */
-#define SRD_ERR_PYTHON		-4 /* Python C API error */
-#define SRD_ERR_DECODERS_DIR	-5 /* Protocol decoder path invalid */
+#define SRD_OK			 0 /**< No error */
+#define SRD_ERR			-1 /**< Generic/unspecified error */
+#define SRD_ERR_MALLOC		-2 /**< Malloc/calloc/realloc error */
+#define SRD_ERR_ARGS		-3 /**< Function argument error */
+#define SRD_ERR_PYTHON		-4 /**< Python C API error */
+#define SRD_ERR_DECODERS_DIR	-5 /**< Protocol decoder path invalid */
 
 /* TODO: Documentation. */
 struct srd_decoder {
+	/** The decoder ID. Must be non-NULL and unique for all decoders. */
 	char *id;
+
+	/** The (short) decoder name. */
 	char *name;
+
+	/** The (long) decoder name. May be NULL. */
 	char *longname;
+
+	/** A (short, one-line) description of the decoder. */
 	char *desc;
+
+	/** A (long, multi-line) description of the decoder. May be NULL. */
 	char *longdesc;
+
+	/** The author of the decoder. May be NULL. */
 	char *author;
+
+	/** An email address of the decoder's author. May be NULL. */
 	char *email;
+
+	/** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
 	char *license;
 
+	/** TODO */
 	char *func;
 
+	/** TODO */
 	GSList *inputformats;
+
+	/** TODO */
 	GSList *outputformats;
 
+	/** TODO */
 	PyObject *py_mod;
+
+	/** TODO */
 	PyObject *py_func;
 };