]> sigrok.org Git - libsigrok.git/commitdiff
doxygen: Fix/improve 'struct sr_probe_group' documentation.
authorUwe Hermann <redacted>
Mon, 11 Nov 2013 06:42:51 +0000 (07:42 +0100)
committerUwe Hermann <redacted>
Mon, 11 Nov 2013 06:42:51 +0000 (07:42 +0100)
libsigrok.h

index 985473c692728485aeb06e18be2992744aabac05..7f18d6902d596c4917da3b016b48f2a01cb21381 100644 (file)
@@ -550,11 +550,13 @@ struct sr_probe {
        char *trigger;
 };
 
+/** Structure for groups of probes that have common properties. */
 struct sr_probe_group {
+       /** Name of the probe group. */
        char *name;
-       /* List of sr_probe structs. */
+       /** List of sr_probe structs of the probes belonging to this group. */
        GSList *probes;
-       /* Private data for driver use. */
+       /** Private data for driver use. */
        void *priv;
 };