X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=sigrokdecode.h;h=1cc678251c747554575608fa0598b7645ffefbe9;hp=e523a45e9cfe7961f8f0aada1da011a32798e905;hb=abeeed8b6da45e1854bc151a8175836b5ca38e34;hpb=0082d592076fdc3fe06a760d432a48163ee0bd97

diff --git a/sigrokdecode.h b/sigrokdecode.h
index e523a45..1cc6782 100644
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -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;
@@ -199,20 +211,20 @@ typedef struct {
 
 /*--- controller.c ----------------------------------------------------------*/
 
-SRD_API int srd_init(char *path);
+SRD_API int srd_init(const 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);
-SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id);
+			   struct srd_decoder_inst *di_to);
+SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id);
 SRD_API int srd_session_start(int num_probes, int unitsize,
 			      uint64_t samplerate);
-SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
+SRD_API int srd_session_feed(uint64_t start_samplenum, const uint8_t *inbuf,
 			     uint64_t inbuflen);
 SRD_API int srd_register_callback(int output_type,
 				  srd_pd_output_callback_t cb, void *cb_data);
@@ -225,7 +237,7 @@ SRD_API int srd_decoder_load(const char *name);
 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
 SRD_API int srd_decoders_load_all(void);
 SRD_API int srd_decoders_unload_all(void);
-SRD_API char *srd_decoder_doc(struct srd_decoder *dec);
+SRD_API char *srd_decoder_doc(const struct srd_decoder *dec);
 
 /*--- log.c -----------------------------------------------------------------*/