Fix incorrect doxygen comment for srd_decoder_list().

[libsigrokdecode.git] / libsigrokdecode.h

diff --git a/libsigrokdecode.h b/libsigrokdecode.h
index 4476f799b0aa77d8f95286463d647fafbbd67c4f..7f75ab2d5baf2a16e1ef951d11d4653260ec2bd6 100644 (file)
--- a/libsigrokdecode.h
+++ b/libsigrokdecode.h
@@ -22,7 +22,6 @@
 #ifndef LIBSIGROKDECODE_SIGROKDECODE_H
 #define LIBSIGROKDECODE_SIGROKDECODE_H
 
-#include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
 #include <stdint.h>
 #include <glib.h>
 
@@ -65,7 +64,7 @@ struct srd_session;
  */
 
 /** Status/error codes returned by libsigrokdecode functions. */
-enum {
+enum srd_error_code {
        SRD_OK               =  0, /**< No error */
        SRD_ERR              = -1, /**< Generic/unspecified error */
        SRD_ERR_MALLOC       = -2, /**< Malloc/calloc/realloc error */
@@ -81,7 +80,7 @@ enum {
 };
 
 /* libsigrokdecode loglevels. */
-enum {
+enum srd_loglevel {
        SRD_LOG_NONE = 0, /**< Output no messages at all. */
        SRD_LOG_ERR  = 1, /**< Output error messages. */
        SRD_LOG_WARN = 2, /**< Output warnings. */
@@ -126,14 +125,14 @@ enum {
  *   - add a check in module_sigrokdecode.c:Decoder_put()
  *   - add a debug string in type_decoder.c:OUTPUT_TYPES
  */
-enum {
+enum srd_output_type {
        SRD_OUTPUT_ANN,
        SRD_OUTPUT_PYTHON,
        SRD_OUTPUT_BINARY,
        SRD_OUTPUT_META,
 };
 
-enum {
+enum srd_configkey {
        SRD_CONF_SAMPLERATE = 10000,
 };
 
@@ -184,10 +183,10 @@ struct srd_decoder {
        GSList *options;
 
        /** Python module. */
-       PyObject *py_mod;
+       void *py_mod;
 
        /** sigrokdecode.Decoder class. */
-       PyObject *py_dec;
+       void *py_dec;
 };
 
 /**
@@ -221,7 +220,7 @@ struct srd_decoder_annotation_row {
 struct srd_decoder_inst {
        struct srd_decoder *decoder;
        struct srd_session *sess;
-       PyObject *py_inst;
+       void *py_inst;
        char *inst_id;
        GSList *pd_output;
        int dec_num_channels;
@@ -258,32 +257,15 @@ struct srd_proto_data_binary {
        const unsigned char *data;
 };
 
-typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
-                                        void *cb_data);
+typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata,
+                                       void *cb_data);
 
 struct srd_pd_callback {
        int output_type;
-       srd_pd_output_callback_t cb;
+       srd_pd_output_callback cb;
        void *cb_data;
 };
 
-/* Custom Python types: */
-
-typedef struct {
-       PyObject_HEAD
-} srd_Decoder;
-
-typedef struct {
-       PyObject_HEAD
-       struct srd_decoder_inst *di;
-       uint64_t start_samplenum;
-       unsigned int itercnt;
-       uint8_t *inbuf;
-       uint64_t inbuflen;
-       PyObject *sample;
-} srd_logic;
-
-
 /* srd.c */
 SRD_API int srd_init(const char *path);
 SRD_API int srd_exit(void);
@@ -298,7 +280,7 @@ SRD_API int srd_session_send(struct srd_session *sess,
                const uint8_t *inbuf, uint64_t inbuflen);
 SRD_API int srd_session_destroy(struct srd_session *sess);
 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
-               int output_type, srd_pd_output_callback_t cb, void *cb_data);
+               int output_type, srd_pd_output_callback cb, void *cb_data);
 
 /* decoder.c */
 SRD_API const GSList *srd_decoder_list(void);
@@ -322,11 +304,11 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
                const char *inst_id);
 
 /* log.c */
-typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
+typedef int (*srd_log_callback)(void *cb_data, int loglevel,
                                  const char *format, va_list args);
 SRD_API int srd_log_loglevel_set(int loglevel);
 SRD_API int srd_log_loglevel_get(void);
-SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
+SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data);
 SRD_API int srd_log_callback_set_default(void);
 SRD_API int srd_log_logdomain_set(const char *logdomain);
 SRD_API char *srd_log_logdomain_get(void);