summaryrefslogtreecommitdiff
path: root/session.c
diff options
context:
space:
mode:
authorUwe Hermann <uwe@hermann-uwe.de>2016-08-25 21:57:39 +0200
committerUwe Hermann <uwe@hermann-uwe.de>2016-08-25 21:57:39 +0200
commite27347a42f06d4ff19b061f89a2257df1fc13098 (patch)
tree9cb2d4e5b85544064c7b0f4cf1b4fee6676d54c4 /session.c
parente1fefac5ab598c09968dc4729d07989fe9753498 (diff)
downloadlibsigrokdecode-e27347a42f06d4ff19b061f89a2257df1fc13098.tar.gz
libsigrokdecode-e27347a42f06d4ff19b061f89a2257df1fc13098.zip
srd_session_send(): Improve Doxygen comments.
Diffstat (limited to 'session.c')
-rw-r--r--session.c8
1 files changed, 4 insertions, 4 deletions
diff --git a/session.c b/session.c
index 16c8c9e..e1bb4f9 100644
--- a/session.c
+++ b/session.c
@@ -224,12 +224,12 @@ SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
* has been configured, it is the minimum number of bytes needed to store
* the default channels.
*
- * @param sess The session to use.
+ * @param sess The session to use. Must not be NULL.
* @param start_samplenum The sample number of the first sample in this chunk.
* @param end_samplenum The sample number of the last sample in this chunk.
- * @param inbuf Pointer to sample data.
- * @param inbuflen Length in bytes of the buffer.
- * @param unitsize The number of bytes per sample.
+ * @param inbuf Pointer to sample data. Must not be NULL.
+ * @param inbuflen Length in bytes of the buffer. Must be > 0.
+ * @param unitsize The number of bytes per sample. Must be > 0.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*