doxygen: @since tags document only last API change.
If a function existed before but the API changed, the @since tag only reflects the release of the last API change.
This commit is contained in:
parent
ef1020f9cb
commit
53f05fa80f
|
@ -322,7 +322,7 @@ static int sanity_check_all_output_modules(void)
|
||||||
* the context will be free'd by sr_exit() as part of the libsigrok
|
* the context will be free'd by sr_exit() as part of the libsigrok
|
||||||
* shutdown.
|
* shutdown.
|
||||||
*
|
*
|
||||||
* @since 0.1.0 (but the API changed in 0.2.0)
|
* @since 0.2.0
|
||||||
*/
|
*/
|
||||||
SR_API int sr_init(struct sr_context **ctx)
|
SR_API int sr_init(struct sr_context **ctx)
|
||||||
{
|
{
|
||||||
|
@ -384,7 +384,7 @@ done:
|
||||||
*
|
*
|
||||||
* @return SR_OK upon success, a (negative) error code otherwise.
|
* @return SR_OK upon success, a (negative) error code otherwise.
|
||||||
*
|
*
|
||||||
* @since 0.1.0 (but the API changed in 0.2.0)
|
* @since 0.2.0
|
||||||
*/
|
*/
|
||||||
SR_API int sr_exit(struct sr_context *ctx)
|
SR_API int sr_exit(struct sr_context *ctx)
|
||||||
{
|
{
|
||||||
|
|
8
device.c
8
device.c
|
@ -80,7 +80,7 @@ SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
|
||||||
*
|
*
|
||||||
* @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
|
* @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
|
||||||
*
|
*
|
||||||
* @since 0.1.0 (but the API changed in 0.2.0)
|
* @since 0.2.0
|
||||||
*/
|
*/
|
||||||
SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi,
|
SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi,
|
||||||
int probenum, const char *name)
|
int probenum, const char *name)
|
||||||
|
@ -154,7 +154,7 @@ SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
|
||||||
*
|
*
|
||||||
* @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
|
* @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
|
||||||
*
|
*
|
||||||
* @since 0.1.0 (but the API changed in 0.2.0)
|
* @since 0.2.0
|
||||||
*/
|
*/
|
||||||
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)
|
||||||
|
@ -196,7 +196,7 @@ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
|
||||||
* FALSE is also returned on invalid input parameters or other
|
* FALSE is also returned on invalid input parameters or other
|
||||||
* error conditions.
|
* error conditions.
|
||||||
*
|
*
|
||||||
* @since 0.1.0 (but the API changed in 0.2.0)
|
* @since 0.2.0
|
||||||
*/
|
*/
|
||||||
SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
|
SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
|
||||||
{
|
{
|
||||||
|
@ -352,7 +352,7 @@ SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
|
||||||
* @return The list of devices/instances of this driver, or NULL upon errors
|
* @return The list of devices/instances of this driver, or NULL upon errors
|
||||||
* or if the list is empty.
|
* or if the list is empty.
|
||||||
*
|
*
|
||||||
* @since 0.1.0 (but the API changed in 0.2.0)
|
* @since 0.2.0
|
||||||
*/
|
*/
|
||||||
SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
|
SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
|
||||||
{
|
{
|
||||||
|
|
2
filter.c
2
filter.c
|
@ -96,7 +96,7 @@
|
||||||
* If something other than SR_OK is returned, the values of
|
* If something other than SR_OK is returned, the values of
|
||||||
* out_unitsize, data_out, and length_out are undefined.
|
* out_unitsize, data_out, and length_out are undefined.
|
||||||
*
|
*
|
||||||
* @since 0.1.0 (but the API changed in 0.2.0)
|
* @since 0.2.0
|
||||||
*/
|
*/
|
||||||
SR_API int sr_filter_probes(unsigned int in_unitsize, unsigned int out_unitsize,
|
SR_API int sr_filter_probes(unsigned int in_unitsize, unsigned int out_unitsize,
|
||||||
const GArray *probe_array, const uint8_t *data_in,
|
const GArray *probe_array, const uint8_t *data_in,
|
||||||
|
|
Loading…
Reference in New Issue