X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrokdecode.h;h=287f2d5a4cf56c70739a4f797957402509901d5c;hb=cebf5db0d181381417ba7908c1180f956b264fb6;hp=55620a7f52551df6e01ea1521711ce34fdf12496;hpb=fb2496413d46b2a19dd8945c0ca7364b3472213a;p=libsigrokdecode.git

diff --git a/libsigrokdecode.h b/libsigrokdecode.h
index 55620a7..287f2d5 100644
--- a/libsigrokdecode.h
+++ b/libsigrokdecode.h
@@ -168,8 +168,8 @@ struct srd_decoder {
 	GSList *opt_channels;
 
 	/**
-	 * List of NULL-terminated char[], containing descriptions of the
-	 * supported annotation output.
+	 * List of annotation classes. Each list item is a GSList itself, with
+	 * two NUL-terminated strings: name and description.
 	 */
 	GSList *annotations;
 
@@ -180,8 +180,8 @@ struct srd_decoder {
 	GSList *annotation_rows;
 
 	/**
-	 * List of NULL-terminated char[], containing descriptions of the
-	 * supported binary output.
+	 * List of binary classes. Each list item is a GSList itself, with
+	 * two NUL-terminated strings: name and description.
 	 */
 	GSList *binary;
 
@@ -303,11 +303,11 @@ struct srd_proto_data {
 	void *data;
 };
 struct srd_proto_data_annotation {
-	int ann_class;
+	int ann_class; /* Index into "struct srd_decoder"->annotations. */
 	char **ann_text;
 };
 struct srd_proto_data_binary {
-	int bin_class;
+	int bin_class; /* Index into "struct srd_decoder"->binary. */
 	uint64_t size;
 	const unsigned char *data;
 };