sr: cosmetic changes

This commit is contained in:
Bert Vermeulen 2012-07-22 15:15:26 +02:00
parent ff14f01b20
commit c7ee3ddb94
1 changed files with 4 additions and 10 deletions

View File

@ -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 * If the specified probe of this device already has a trigger, it will
* be silently replaced. * be silently replaced.
* *
* TODO: Better description. * @param sdi Must not be NULL.
* TODO: Describe valid format of the 'trigger' string. * @param probenum The number of the probe.
*
* @param dev TODO. Must not be NULL.
* @param probenum The number of the probe. TODO.
* Note that the probe numbers start at 1 (not 0!). * Note that the probe numbers start at 1 (not 0!).
* @param trigger TODO. * @param trigger trigger string, in the format used by sigrok-cli
* TODO: Is NULL allowed?
* *
* @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
* upon other errors.
* If something other than SR_OK is returned, 'dev' is unchanged.
*/ */
SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
const char *trigger) const char *trigger)