summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcus Comstedt <marcus@mc.pp.se>2017-02-26 13:10:06 +0100
committerUwe Hermann <uwe@hermann-uwe.de>2017-02-26 14:56:56 +0100
commit2f7bc9d2c4faa65bf1e8130d978c10c177f85444 (patch)
tree5e8ccc5471515d11b0a1b77e38954eab3cdd3aec
parentde23c992a48b5f9f145a7c26a62f10cd5b87b218 (diff)
downloadlibsigrokdecode-2f7bc9d2c4faa65bf1e8130d978c10c177f85444.tar.gz
libsigrokdecode-2f7bc9d2c4faa65bf1e8130d978c10c177f85444.zip
Fix examples to show abs_end_samplenum as exclusive
-rw-r--r--instance.c30
1 files changed, 15 insertions, 15 deletions
diff --git a/instance.c b/instance.c
index 0e27ca3..6c54d8d 100644
--- a/instance.c
+++ b/instance.c
@@ -948,28 +948,28 @@ static gpointer di_thread(gpointer data)
* sample numbers within the chunk specified by 'inbuf' and 'inbuflen'.
*
* Correct example (4096 samples total, 4 chunks @ 1024 samples each):
- * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
- * srd_inst_decode(di, 1024, 2047, inbuf, 1024, 1);
- * srd_inst_decode(di, 2048, 3071, inbuf, 1024, 1);
- * srd_inst_decode(di, 3072, 4095, inbuf, 1024, 1);
+ * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
+ * srd_inst_decode(di, 1024, 2048, inbuf, 1024, 1);
+ * srd_inst_decode(di, 2048, 3072, inbuf, 1024, 1);
+ * srd_inst_decode(di, 3072, 4096, inbuf, 1024, 1);
*
* The chunk size ('inbuflen') can be arbitrary and can differ between calls.
*
* Correct example (4096 samples total, 7 chunks @ various samples each):
- * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
- * srd_inst_decode(di, 1024, 1123, inbuf, 100, 1);
- * srd_inst_decode(di, 1124, 1423, inbuf, 300, 1);
- * srd_inst_decode(di, 1424, 1642, inbuf, 219, 1);
- * srd_inst_decode(di, 1643, 2047, inbuf, 405, 1);
- * srd_inst_decode(di, 2048, 3071, inbuf, 1024, 1);
- * srd_inst_decode(di, 3072, 4095, inbuf, 1024, 1);
+ * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
+ * srd_inst_decode(di, 1024, 1124, inbuf, 100, 1);
+ * srd_inst_decode(di, 1124, 1424, inbuf, 300, 1);
+ * srd_inst_decode(di, 1424, 1643, inbuf, 219, 1);
+ * srd_inst_decode(di, 1643, 2048, inbuf, 405, 1);
+ * srd_inst_decode(di, 2048, 3072, inbuf, 1024, 1);
+ * srd_inst_decode(di, 3072, 4096, inbuf, 1024, 1);
*
* INCORRECT example (4096 samples total, 4 chunks @ 1024 samples each, but
* the start- and end-samplenumbers are not absolute):
- * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
- * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
- * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
- * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
+ * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
+ * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
+ * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
+ * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
*
* @param di The decoder instance to call. Must not be NULL.
* @param abs_start_samplenum The absolute starting sample number for the