From 49f2cdc76dd405dfb674da1284349a28f75c2ebd Mon Sep 17 00:00:00 2001 From: Uwe Hermann Date: Tue, 10 Dec 2019 22:00:05 +0100 Subject: struct srd_decoder: Fix/improve some documentation comments. --- libsigrokdecode.h | 12 ++++++------ util.c | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/libsigrokdecode.h b/libsigrokdecode.h index 84c80e4..b9cc921 100644 --- a/libsigrokdecode.h +++ b/libsigrokdecode.h @@ -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 b7fd4fb..1e914e3 100644 --- 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. * -- cgit v1.2.3-70-g09d2