summaryrefslogtreecommitdiff
path: root/decoder.c
diff options
context:
space:
mode:
authorUwe Hermann <uwe@hermann-uwe.de>2013-05-03 14:45:49 +0200
committerUwe Hermann <uwe@hermann-uwe.de>2013-05-03 20:41:31 +0200
commit8c664ca2d7b4faffa7b3dbeb3b9e491976c24eee (patch)
tree8e9f7c92d32c148c75449a6019ccb6a7fbd00011 /decoder.c
parentf11e9498c83d4b27ffc1029f6dbd7ef871953aca (diff)
downloadlibsigrokdecode-8c664ca2d7b4faffa7b3dbeb3b9e491976c24eee.tar.gz
libsigrokdecode-8c664ca2d7b4faffa7b3dbeb3b9e491976c24eee.zip
Doxygen: Add @since markers to API functions.
Also, document the functions in version.c.
Diffstat (limited to 'decoder.c')
-rw-r--r--decoder.c14
1 files changed, 14 insertions, 0 deletions
diff --git a/decoder.c b/decoder.c
index 3716537..c8eb98f 100644
--- a/decoder.c
+++ b/decoder.c
@@ -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)
{