]> sigrok.org Git - libsigrok.git/commitdiff
sr: cosmetic changes
authorBert Vermeulen <redacted>
Sun, 22 Jul 2012 13:15:26 +0000 (15:15 +0200)
committerBert Vermeulen <redacted>
Fri, 3 Aug 2012 09:27:31 +0000 (11:27 +0200)
device.c

index 98e9fdac7f4f60b43ae40b535d6829d0c6e379b4..3f0b60d0d20b5574477a29475297b9c917c6c614 100644 (file)
--- a/device.c
+++ b/device.c
@@ -348,18 +348,12 @@ SR_API int sr_dev_trigger_remove_all(struct sr_dev *dev)
  * 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.
- *
- * @param dev TODO. Must not be NULL.
- * @param probenum The number of the probe. TODO.
+ * @param sdi Must not be NULL.
+ * @param probenum The number of the probe.
  *                 Note that the probe numbers start at 1 (not 0!).
- * @param trigger TODO.
- *                TODO: Is NULL allowed?
+ * @param trigger trigger string, in the format used by sigrok-cli
  *
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
- *         upon other errors.
- *         If something other than SR_OK is returned, 'dev' is unchanged.
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  */
 SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
                const char *trigger)