From: Uwe Hermann <redacted>
Date: Thu, 25 Aug 2016 19:57:39 +0000 (+0200)
Subject: srd_session_send(): Improve Doxygen comments.
X-Git-Tag: libsigrokdecode-0.5.0~154
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=e27347a42f06d4ff19b061f89a2257df1fc13098;p=libsigrokdecode.git

srd_session_send(): Improve Doxygen comments.
---

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.
  *