srd: last public/private fix, and docs for all publis functions.

[libsigrokdecode.git] / decoder.c

diff --git a/decoder.c b/decoder.c
index 557aa71c8c39eede1b0cd28f3007687e96012289..e3f847d205ea7db534ad9e93b2372fb7bf057774 100644 (file)
--- a/decoder.c
+++ b/decoder.c
@@ -45,6 +45,7 @@ SRD_API GSList *srd_list_decoders(void)
  * Get the decoder with the specified ID.
  *
  * @param id The ID string of the decoder to return.
+ *
  * @return The decoder with the specified ID, or NULL if not found.
  */
 SRD_API struct srd_decoder *srd_get_decoder_by_id(const char *id)
@@ -95,6 +96,7 @@ static int get_probes(struct srd_decoder *d, char *attr, GSList **pl)
                }
 
                if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
+                       srd_err("Failed to g_malloc() struct srd_probe.");
                        ret = SRD_ERR_MALLOC;
                        goto err_out;
                }
@@ -138,7 +140,7 @@ SRD_API int srd_load_decoder(const char *name, struct srd_decoder **dec)
        py_basedec = py_method = py_attr = NULL;
 
        if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
-               srd_dbg("Failed to malloc struct srd_decoder.");
+               srd_dbg("Failed to g_malloc() struct srd_decoder.");
                ret = SRD_ERR_MALLOC;
                goto err_out;
        }
@@ -280,6 +282,14 @@ err_out:
        return ret;
 }
 
+/**
+ * Return a protocol decoder's docstring.
+ *
+ * @param dec The loaded protocol decoder.
+ *
+ * @return A newly allocated buffer containing the docstring. The caller should
+ * free this after use.
+ */
 SRD_API char *srd_decoder_doc(struct srd_decoder *dec)
 {
        PyObject *py_str;
@@ -335,7 +345,7 @@ SRD_API int srd_unload_decoder(struct srd_decoder *dec)
         * but they could be anywhere in the stack, just free the entire
         * stack. A frontend reloading a decoder thus has to restart all
         * instances, and rebuild the stack. */
-       srd_instance_free_all(NULL);
+       srd_inst_free_all(NULL);
 
        free_probes(dec->probes);
        free_probes(dec->opt_probes);
@@ -361,6 +371,11 @@ SRD_API int srd_unload_decoder(struct srd_decoder *dec)
        return SRD_OK;
 }
 
+/**
+ * Load all protocol decoders libsigrokdecode knows about.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
 SRD_API int srd_load_all_decoders(void)
 {
        GDir *dir;
@@ -389,7 +404,9 @@ SRD_API int srd_load_all_decoders(void)
 }
 
 /**
- * TODO
+ * Unload all loaded protocol decoders.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
  */
 SRD_API int srd_unload_all_decoders(void)
 {