]> sigrok.org Git - libsigrok.git/blobdiff - libsigrok.h
doxygen: Fix/improve 'struct sr_probe_group' documentation.
[libsigrok.git] / libsigrok.h
index 9036b05f52773315de4dc537d9f39718fafb2644..7f18d6902d596c4917da3b016b48f2a01cb21381 100644 (file)
@@ -73,6 +73,7 @@ enum {
        SR_ERR_NA         = -6, /**< Not applicable. */
        SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but needs to be open. */
        SR_ERR_TIMEOUT    = -8, /**< A timeout occurred. */
+       SR_ERR_PROBE_GROUP= -9, /**< A probe group must be specified. */
 
        /*
         * Note: When adding entries here, don't forget to also update the
@@ -549,10 +550,13 @@ struct sr_probe {
        char *trigger;
 };
 
+/** Structure for groups of probes that have common properties. */
 struct sr_probe_group {
-       /* List of sr_probe structs. */
+       /** Name of the probe group. */
+       char *name;
+       /** 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;
 };