X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoder.c;h=21e24c471d6178610dacd5bdc3885d17221a9e99;hp=f606bb7aefc56dce6ace36effa4ab712a52a9ecb;hb=c1f86f02a149f46609273e1bd5b42696d544727a;hpb=2f395bff8f096ef738140913e2d01ff0a8c07002 diff --git a/decoder.c b/decoder.c index f606bb7..21e24c4 100644 --- a/decoder.c +++ b/decoder.c @@ -1,5 +1,5 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrokdecode project. * * Copyright (C) 2010 Uwe Hermann * Copyright (C) 2012 Bert Vermeulen @@ -19,8 +19,8 @@ */ #include "config.h" -#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ -#include "sigrokdecode-internal.h" +#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#include "libsigrokdecode-internal.h" #include /** @@ -53,6 +53,8 @@ extern SRD_PRIV PyObject *mod_sigrokdecode; * This is a GSList containing the names of the decoders as strings. * * @return List of decoders, NULL if none are supported or loaded. + * + * @since 0.1.0 (but the API changed in 0.2.0) */ SRD_API const GSList *srd_decoder_list(void) { @@ -65,6 +67,8 @@ SRD_API const GSList *srd_decoder_list(void) * @param id The ID string of the decoder to return. * * @return The decoder with the specified ID, or NULL if not found. + * + * @since 0.1.0 */ SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id) { @@ -232,6 +236,8 @@ err_out: * @param module_name The module name to be loaded. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.1.0 */ SRD_API int srd_decoder_load(const char *module_name) { @@ -399,6 +405,8 @@ err_out: * * @return A newly allocated buffer containing the protocol decoder's * documentation. The caller is responsible for free'ing the buffer. + * + * @since 0.1.0 */ SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec) { @@ -445,6 +453,8 @@ static void free_probes(GSList *probelist) * @param dec The struct srd_decoder to be unloaded. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.1.0 */ SRD_API int srd_decoder_unload(struct srd_decoder *dec) { @@ -492,6 +502,8 @@ SRD_API int srd_decoder_unload(struct srd_decoder *dec) * Load all installed protocol decoders. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.1.0 */ SRD_API int srd_decoder_load_all(void) { @@ -517,6 +529,8 @@ SRD_API int srd_decoder_load_all(void) * Unload all loaded protocol decoders. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.1.0 */ SRD_API int srd_decoder_unload_all(void) {