]> sigrok.org Git - libsigrok.git/commitdiff
sr: s/_clear/_remove_all/ for consistency.
authorUwe Hermann <redacted>
Wed, 28 Mar 2012 19:55:48 +0000 (21:55 +0200)
committerUwe Hermann <redacted>
Sat, 31 Mar 2012 09:33:43 +0000 (11:33 +0200)
device.c
session.c
sigrok-proto.h

index 99e9c378977fbca73d1674e53fafc443149ecb0f..63b1f100560887a9205132b43035eed52ef772b3 100644 (file)
--- a/device.c
+++ b/device.c
@@ -283,7 +283,7 @@ SR_API int sr_dev_probe_name_set(struct sr_dev *dev, int probenum,
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  *         If something other than SR_OK is returned, 'dev' is unchanged.
  */
-SR_API int sr_dev_trigger_clear(struct sr_dev *dev)
+SR_API int sr_dev_trigger_remove_all(struct sr_dev *dev)
 {
        struct sr_probe *p;
        unsigned int pnum; /* TODO: uint16_t? */
@@ -311,7 +311,10 @@ SR_API int sr_dev_trigger_clear(struct sr_dev *dev)
 }
 
 /**
- * Add a trigger to the specified device.
+ * Add a trigger to the specified device (and the specified probe).
+ *
+ * If the specified probe of this device already has a trigger, it will
+ * be silently replaced.
  *
  * TODO: Better description.
  * TODO: Describe valid format of the 'trigger' string.
index 8048fdfd7b22e00dc3294395076d23b8672a0dd4..f1a8370bf48784641973a978ae5ba45a28f110bb 100644 (file)
--- a/session.c
+++ b/session.c
@@ -97,7 +97,7 @@ SR_API int sr_session_destroy(void)
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-SR_API int sr_session_dev_clear(void)
+SR_API int sr_session_dev_remove_all(void)
 {
        if (!session) {
                sr_err("session: %s: session was NULL", __func__);
@@ -159,11 +159,11 @@ SR_API int sr_session_dev_add(struct sr_dev *dev)
 }
 
 /**
- * Clear all datafeed callbacks in the current session.
+ * Remove all datafeed callbacks in the current session.
  *
  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
  */
-SR_API int sr_session_datafeed_callback_clear(void)
+SR_API int sr_session_datafeed_callback_remove_all(void)
 {
        if (!session) {
                sr_err("session: %s: session was NULL", __func__);
index 2c45c01eb3420659bb32fe2e5e835a281c9af69a..70342a1328f638fc169a75969abb6b3333cac097 100644 (file)
@@ -56,7 +56,7 @@ SR_API struct sr_probe *sr_dev_probe_find(const struct sr_dev *dev,
                                          int probenum);
 SR_API int sr_dev_probe_name_set(struct sr_dev *dev, int probenum,
                                 const char *name);
-SR_API int sr_dev_trigger_clear(struct sr_dev *dev);
+SR_API int sr_dev_trigger_remove_all(struct sr_dev *dev);
 SR_API int sr_dev_trigger_set(struct sr_dev *dev, int probenum,
                              const char *trigger);
 SR_API gboolean sr_dev_has_hwcap(const struct sr_dev *dev, int hwcap);
@@ -85,11 +85,11 @@ typedef void (*sr_datafeed_callback_t)(struct sr_dev *dev,
 SR_API int sr_session_load(const char *filename);
 SR_API struct sr_session *sr_session_new(void);
 SR_API int sr_session_destroy(void);
-SR_API int sr_session_dev_clear(void);
+SR_API int sr_session_dev_remove_all(void);
 SR_API int sr_session_dev_add(struct sr_dev *dev);
 
 /* Datafeed setup */
-SR_API int sr_session_datafeed_callback_clear(void);
+SR_API int sr_session_datafeed_callback_remove_all(void);
 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb);
 
 /* Session control */