srd: Cosmetics, fix/add Doxygen comments.
authorUwe Hermann <uwe@hermann-uwe.de>
Thu, 15 Mar 2012 21:00:24 +0000 (22:00 +0100)
committerUwe Hermann <uwe@hermann-uwe.de>
Sun, 18 Mar 2012 13:34:22 +0000 (14:34 +0100)
controller.c
decoder.c
exception.c
module_sigrokdecode.c
sigrokdecode-internal.h
sigrokdecode.h
type_decoder.c

index 3ebf5a9e4c77a4bb313a32f4f074910c9be21d7e..5ffe7ae21bfc2a8c51a18b8e27425b835c02e724 100644 (file)
@@ -28,7 +28,7 @@
 /* List of decoder instances. */
 static GSList *di_list = NULL;
 
-/* List of frontend callbacks to receive PD output. */
+/* List of frontend callbacks to receive decoder output. */
 static GSList *callbacks = NULL;
 
 /* decoder.c */
@@ -44,7 +44,7 @@ extern SRD_PRIV PyTypeObject srd_logic_type;
  * Initialize libsigrokdecode.
  *
  * This initializes the Python interpreter, and creates and initializes
- * a "sigrok" Python module with a single put() method.
+ * a "sigrokdecode" Python module.
  *
  * Then, it searches for sigrok protocol decoder files (*.py) in the
  * "decoders" subdirectory of the the sigrok installation directory.
@@ -58,7 +58,7 @@ extern SRD_PRIV PyTypeObject srd_logic_type;
  * are not allowed.
  *
  * @param path Path to an extra directory containing protocol decoders
- *             which will be added to the python sys.path, or NULL.
+ *             which will be added to the Python sys.path, or NULL.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *         Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
@@ -138,8 +138,8 @@ SRD_API int srd_exit(void)
  * Python modules which have the same name as a sigrok protocol decoder in
  * sys.path or in the current working directory.
  *
- * @param path Path to an extra directory containing protocol decoders
- *             which will be added to the python sys.path, or NULL.
+ * @param path Path to the directory containing protocol decoders which shall
+ *             be added to the Python sys.path, or NULL.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
@@ -199,15 +199,15 @@ SRD_PRIV int add_modulepath(const char *path)
 /**
  * Set options in a decoder instance.
  *
+ * Handled options are removed from the hash.
+ *
  * @param di Decoder instance.
  * @param options A GHashTable of options to set.
  *
- * Handled options are removed from the hash.
- *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
 SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
-                                    GHashTable *options)
+                                GHashTable *options)
 {
        PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
        PyObject *py_optlist, *py_classval;
@@ -293,7 +293,8 @@ SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
                        }
                }
 
-               /* If we got here, py_optval holds a known good new reference
+               /*
+                * If we got here, py_optval holds a known good new reference
                 * to the instance option to set.
                 */
                if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
@@ -331,7 +332,7 @@ static gint compare_probe_id(struct srd_probe *a, char *probe_id)
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
 SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
-                                   GHashTable *new_probes)
+                               GHashTable *new_probes)
 {
        GList *l;
        GSList *sl;
@@ -404,7 +405,7 @@ SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
  *         NULL in case of failure.
  */
 SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
-                                                     GHashTable *options)
+                                             GHashTable *options)
 {
        int i;
        struct srd_decoder *dec;
@@ -428,7 +429,8 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
        di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
        g_hash_table_remove(options, "id");
 
-       /* Prepare a default probe map, where samples come in the
+       /*
+        * Prepare a default probe map, where samples come in the
         * order in which the decoder class defined them.
         */
        di->dec_num_probes = g_slist_length(di->decoder->probes) +
@@ -494,9 +496,10 @@ SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
 }
 
 /**
- * Finds a decoder instance by its instance ID, but only in the bottom
- * level of instances -- instances already stacked on top of another one
- * will not be found.
+ * Find a decoder instance by its instance ID.
+ *
+ * Only the bottom level of instances are searched -- instances already stacked
+ * on top of another one will not be found.
  *
  * @param inst_id The instance ID to be found.
  *
@@ -520,19 +523,20 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id)
 }
 
 /**
- * Finds a decoder instance by its Python object, i.e. that instance's
- * instantiation of the sigrokdecode.Decoder class. This will recurse
- * to find the instance anywhere in the stack tree.
+ * Find a decoder instance by its Python object.
+ *
+ * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
+ * This will recurse to find the instance anywhere in the stack tree.
  *
- * @param stack Pointer to a GSList of struct srd_decoder_inst,
- *             indicating the stack to search. To start searching at the bottom
- *             level of decoder instances, pass NULL.
+ * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
+ *              stack to search. To start searching at the bottom level of
+ *              decoder instances, pass NULL.
  * @param obj The Python class instantiation.
  *
  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
  */
 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
-                                                             PyObject *obj)
+                                                     PyObject *obj)
 {
        GSList *l;
        struct srd_decoder_inst *tmp, *di;
@@ -575,7 +579,8 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
        Py_DecRef(py_res);
        Py_DecRef(py_name);
 
-       /* Start all the PDs stacked on top of this one. Pass along the
+       /*
+        * Start all the PDs stacked on top of this one. Pass along the
         * metadata all the way from the bottom PD, even though it's only
         * applicable to logic data for now.
         */
@@ -623,7 +628,8 @@ SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
                return SRD_ERR_ARG;
        }
 
-       /* Create new srd_logic object. Each iteration around the PD's loop
+       /*
+        * Create new srd_logic object. Each iteration around the PD's loop
         * will fill one sample into this object.
         */
        logic = PyObject_New(srd_logic, &srd_logic_type);
@@ -694,7 +700,7 @@ SRD_PRIV void srd_inst_free_all(GSList *stack)
  *
  * @param num_probes The number of probes which the incoming feed will contain.
  * @param unitsize The number of bytes per sample in the incoming feed.
- * @param The samplerate of the incoming feed.
+ * @param samplerate The samplerate of the incoming feed.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
@@ -708,7 +714,8 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
        srd_dbg("Calling start() on all instances with %d probes, "
                "unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
 
-       /* Currently only one item of metadata is passed along to decoders,
+       /*
+        * Currently only one item of metadata is passed along to decoders,
         * samplerate. This can be extended as needed.
         */
        if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
@@ -752,7 +759,7 @@ SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
 
        for (d = di_list; d; d = d->next) {
                if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf,
-                                              inbuflen)) != SRD_OK)
+                                          inbuflen)) != SRD_OK)
                        return ret;
        }
 
@@ -768,8 +775,8 @@ SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
  *
  * @param output_type The output type this callback will receive. Only one
  *                    callback per output type can be registered.
- * @param cb The function to call.
- * @param cb_data Unused.
+ * @param cb The function to call. Must not be NULL.
+ * @param cb_data Private data for the callback function. Can be NULL.
  */
 SRD_API int srd_register_callback(int output_type,
                                  srd_pd_output_callback_t cb, void *cb_data)
index 365e906a5a8d3424d0e711e387b6226d3126d0e2..4d886c7d5d0435016a2fdf88a4c793eb05d20642 100644 (file)
--- a/decoder.c
+++ b/decoder.c
@@ -148,7 +148,7 @@ SRD_API int srd_decoder_load(const char *module_name)
 
        /* Import the Python module. */
        if (!(d->py_mod = PyImport_ImportModule(module_name))) {
-               catch_exception("import of '%s' failed.", module_name);
+               catch_exception("Import of '%s' failed.", module_name);
                goto err_out;
        }
 
@@ -156,7 +156,8 @@ SRD_API int srd_decoder_load(const char *module_name)
        if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
                /* This generated an AttributeError exception. */
                PyErr_Clear();
-               srd_err("Decoder class not found in protocol decoder %s.", module_name);
+               srd_err("Decoder class not found in protocol decoder %s.",
+                       module_name);
                goto err_out;
        }
 
@@ -240,7 +241,7 @@ SRD_API int srd_decoder_load(const char *module_name)
        d->inputformats = NULL;
        d->outputformats = NULL;
 
-       /* Convert class annotation attribute to GSList of **char */
+       /* Convert class annotation attribute to GSList of **char. */
        d->annotations = NULL;
        if (PyObject_HasAttrString(d->py_dec, "annotations")) {
                py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
@@ -288,8 +289,8 @@ err_out:
  *
  * @param dec The loaded protocol decoder.
  *
- * @return A newly allocated buffer containing the docstring. The caller should
- * free this after use.
+ * @return A newly allocated buffer containing the protocol decoder's
+ *         documentation. The caller is responsible for free'ing this after use.
  */
 SRD_API char *srd_decoder_doc(struct srd_decoder *dec)
 {
@@ -328,7 +329,6 @@ static void free_probes(GSList *probelist)
                g_free(p);
        }
        g_slist_free(probelist);
-
 }
 
 /**
@@ -340,12 +340,14 @@ static void free_probes(GSList *probelist)
  */
 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
 {
-       srd_dbg("unloading decoder %s", dec->name);
+       srd_dbg("Unloading decoder '%s'.", dec->name);
 
-       /* Since any instances of this decoder need to be released as well,
+       /*
+        * Since any instances of this decoder need to be released as well,
         * 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. */
+        * instances, and rebuild the stack.
+        */
        srd_inst_free_all(NULL);
 
        free_probes(dec->probes);
index 1f30c80d95a440b2a8ab7c62fb08e1d24bc463bd..de31c5fa37f67fb5856b4303af1cd1c1db494214 100644 (file)
@@ -67,7 +67,7 @@ SRD_PRIV void catch_exception(const char *format, ...)
        /* Send a more precise error location to srd_dbg(), if we have it. */
        if (etb && etb != Py_None) {
                tracestr = NULL;
-               py_tb = (PyTracebackObject *) etb;
+               py_tb = (PyTracebackObject *)etb;
                py_str = PyUnicode_FromFormat("%U:%d in %U",
                                        py_tb->tb_frame->f_code->co_filename,
                                        py_tb->tb_frame->f_lineno,
index 0fe109619f17227ff908ac73b0e5f486b2931fff..900f7fd105098f532c6a1d158a31e218f3c670ee 100644 (file)
@@ -44,7 +44,7 @@ SRD_PRIV PyMODINIT_FUNC PyInit_sigrokdecode(void)
 {
        PyObject *mod;
 
-       /* tp_new needs to be assigned here for compiler portability */
+       /* tp_new needs to be assigned here for compiler portability. */
        srd_Decoder_type.tp_new = PyType_GenericNew;
        if (PyType_Ready(&srd_Decoder_type) < 0)
                return NULL;
index 3a9df2edf8accf456a0a54d5edc46f3d00be9750..23f52b85ff845c57ad3201e833e2dd85f0f6f3fd 100644 (file)
 SRD_PRIV int add_modulepath(const char *path);
 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args);
 SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
-                               struct srd_decoder_inst *dec,
-                               uint8_t *inbuf, uint64_t inbuflen);
+                            struct srd_decoder_inst *dec,
+                            uint8_t *inbuf, uint64_t inbuflen);
 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di);
 SRD_PRIV void srd_inst_free_all(GSList *stack);
 SRD_PRIV int pd_add(struct srd_decoder_inst *di, int output_type,
                    char *output_id);
 
 /*--- decoder.c -------------------------------------------------------------*/
+
 SRD_PRIV void *srd_find_callback(int output_type);
 
 /*--- exception.c -----------------------------------------------------------*/
@@ -59,6 +60,6 @@ SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr
 SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr);
 SRD_PRIV int py_strlist_to_char(PyObject *py_strlist, char ***outstr);
 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
-                                                             PyObject *obj);
+                                                      PyObject *obj);
 
 #endif
index e523a45e9cfe7961f8f0aada1da011a32798e905..bebad10551bda713c2a5b7ae8cdd9355416fa1c2 100644 (file)
@@ -101,16 +101,19 @@ struct srd_decoder {
        /** The decoder ID. Must be non-NULL and unique for all decoders. */
        char *id;
 
-       /** The (short) decoder name. */
+       /** The (short) decoder name. Must be non-NULL. */
        char *name;
 
        /** The (long) decoder name. May be NULL. */
        char *longname;
 
-       /** A (short, one-line) description of the decoder. */
+       /** A (short, one-line) description of the decoder. Must be non-NULL. */
        char *desc;
 
-       /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
+       /**
+        * The license of the decoder. Valid values: "gplv2+", "gplv3+".
+        * Other values are currently not allowed. Must be non-NULL.
+        */
        char *license;
 
        /** TODO */
@@ -119,29 +122,37 @@ struct srd_decoder {
        /** TODO */
        GSList *outputformats;
 
-       /** Probes */
+       /** List of probes required by this decoder. */
        GSList *probes;
 
-       /** Optional probes */
+       /** List of optional probes for this decoder. */
        GSList *opt_probes;
 
-       /*
+       /**
         * List of NULL-terminated char[], containing descriptions of the
         * supported annotation output.
         */
        GSList *annotations;
 
-       /** Python module */
+       /** Python module. */
        PyObject *py_mod;
 
-       /** sigrokdecode.Decoder class */
+       /** sigrokdecode.Decoder class. */
        PyObject *py_dec;
 };
 
+/**
+ * Structure which contains information about one protocol decoder probe.
+ * For example, I2C has two probes, SDA and SCL.
+ */
 struct srd_probe {
+       /** The ID of the probe. Must be non-NULL. */
        char *id;
+       /** The name of the probe. Must not be NULL. */
        char *name;
+       /** The description of the probe. Must not be NULL. */
        char *desc;
+       /** The index of the probe, i.e. its order in the list of probes. */
        int order;
 };
 
@@ -182,7 +193,8 @@ struct srd_pd_callback {
        void *cb_data;
 };
 
-/* custom python types */
+/* Custom Python types: */
+
 typedef struct {
        PyObject_HEAD
 } srd_Decoder;
@@ -202,13 +214,13 @@ typedef struct {
 SRD_API int srd_init(char *path);
 SRD_API int srd_exit(void);
 SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
-                                    GHashTable *options);
+                                GHashTable *options);
 SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
-                                   GHashTable *probes);
+                               GHashTable *probes);
 SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
-                                                     GHashTable *options);
+                                             GHashTable *options);
 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
-                              struct srd_decoder_inst *di_to);
+                          struct srd_decoder_inst *di_to);
 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id);
 SRD_API int srd_session_start(int num_probes, int unitsize,
                              uint64_t samplerate);
index 5190cc6de3d9ec3b771e6d2fb3c7080c3992c847..be3cb31e29da5d6f5a56c32f9033773a0a1c2a65 100644 (file)
@@ -36,14 +36,14 @@ static int convert_pyobj(struct srd_decoder_inst *di, PyObject *obj,
        struct srd_pd_output *pdo;
        int ann_id;
 
-       /* Should be a list of [annotation format, [string, ...]] */
+       /* Should be a list of [annotation format, [string, ...]]. */
        if (!PyList_Check(obj) && !PyTuple_Check(obj)) {
                srd_err("Protocol decoder %s submitted %s instead of list.",
                        di->decoder->name, obj->ob_type->tp_name);
                return SRD_ERR_PYTHON;
        }
 
-       /* Should have 2 elements... */
+       /* Should have 2 elements. */
        if (PyList_Size(obj) != 2) {
                srd_err("Protocol decoder %s submitted annotation list with "
                        "%d elements instead of 2", di->decoder->name,
@@ -70,7 +70,7 @@ static int convert_pyobj(struct srd_decoder_inst *di, PyObject *obj,
        }
        *ann_format = ann_id;
 
-       /* Second element must be a list */
+       /* Second element must be a list. */
        py_tmp = PyList_GetItem(obj, 1);
        if (!PyList_Check(py_tmp)) {
                srd_err("Protocol decoder %s submitted annotation list, but "
@@ -148,7 +148,7 @@ static PyObject *Decoder_put(PyObject *self, PyObject *args)
        case SRD_OUTPUT_PROTO:
                for (l = di->next_di; l; l = l->next) {
                        next_di = l->data;
-                       /* TODO: is this needed? */
+                       /* TODO: Is this needed? */
                        Py_XINCREF(next_di->py_inst);
                        srd_spew("Sending %d-%d to instance %s",
                                 start_sample, end_sample,
@@ -156,7 +156,7 @@ static PyObject *Decoder_put(PyObject *self, PyObject *args)
                        if (!(py_res = PyObject_CallMethod(
                            next_di->py_inst, "decode", "KKO", start_sample,
                            end_sample, data))) {
-                               catch_exception("calling %s decode(): ",
+                               catch_exception("Calling %s decode(): ",
                                                next_di->inst_id);
                        }
                        Py_XDECREF(py_res);
@@ -214,6 +214,6 @@ SRD_PRIV PyTypeObject srd_Decoder_type = {
        .tp_name = "sigrokdecode.Decoder",
        .tp_basicsize = sizeof(srd_Decoder),
        .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
-       .tp_doc = "Sigrok Decoder base class",
+       .tp_doc = "sigrok Decoder base class",
        .tp_methods = Decoder_methods,
 };