struct srd_decoder: Fix/improve some documentation comments.
authorUwe Hermann <uwe@hermann-uwe.de>
Tue, 10 Dec 2019 21:00:05 +0000 (22:00 +0100)
committerUwe Hermann <uwe@hermann-uwe.de>
Tue, 10 Dec 2019 21:09:20 +0000 (22:09 +0100)
libsigrokdecode.h
util.c

index 84c80e4195641fcdfea2656a558f672ba057ff9e..b9cc921287e876347ceea9d1ea08f61a46046f2e 100644 (file)
@@ -171,8 +171,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;
 
@@ -183,8 +183,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;
 
@@ -306,11 +306,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;
 };
diff --git a/util.c b/util.c
index b7fd4fb4900728c6df3bc186f22aa141dac0578d..1e914e3e44a1ee0ae2b0d735cd87f29345f66551 100644 (file)
--- a/util.c
+++ b/util.c
@@ -385,7 +385,7 @@ SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr)
 
 /**
  * Convert a Python list of unicode strings to a C string vector.
- * On success, a pointer to a newly allocated NULL-terminated array of
+ * On success, a pointer to a newly allocated NUL-terminated array of
  * allocated C strings is written to @a out_strv. The caller must g_free()
  * each string and the array itself.
  *