]> sigrok.org Git - libsigrok.git/commitdiff
doxygen: @since tags document only last API change.
authorUwe Hermann <redacted>
Sun, 3 Nov 2013 15:08:38 +0000 (16:08 +0100)
committerUwe Hermann <redacted>
Mon, 4 Nov 2013 00:14:56 +0000 (01:14 +0100)
If a function existed before but the API changed, the @since
tag only reflects the release of the last API change.

backend.c
device.c
filter.c

index 42817158f4f11e877a53343280e66bbdbd56b342..0d1b47263f66ba14eb5eff371a1d7773ee9d0eca 100644 (file)
--- a/backend.c
+++ b/backend.c
@@ -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
  *         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)
 {
@@ -384,7 +384,7 @@ done:
  *
  * @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)
 {
index 327ddc73df50b723ee7a314970046dfb764b4eda..b261d6a741b2e93b6a54b958abb532e71361c6a9 100644 (file)
--- a/device.c
+++ b/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.
  *
- * @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,
                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.
  *
- * @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,
                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
  *         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)
 {
@@ -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
  *         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)
 {
index 11cad5c38096771ad442568773b4c24c90d30830..8a00e76dfe5413dd3e22e035e6384776e8c201d3 100644 (file)
--- a/filter.c
+++ b/filter.c
@@ -96,7 +96,7 @@
  *         If something other than SR_OK is returned, the values of
  *         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,
                            const GArray *probe_array, const uint8_t *data_in,