Comment changes.
authorPekka Riikonen <priikone@silcnet.org>
Sat, 28 Oct 2006 13:43:15 +0000 (13:43 +0000)
committerPekka Riikonen <priikone@silcnet.org>
Sat, 28 Oct 2006 13:43:15 +0000 (13:43 +0000)
lib/silcutil/silcbuffer.h

index b88af80e087db8ebcea95b0f9fb45afe71eb18af..5356b3b2485a6bfc298493120dfac3a379adae1a 100644 (file)
  *     section. Tail section can be pulled towards end, and thus the data
  *     section becomes larger.
  *
- * SILC Buffer is not thread-safe.  If the same buffer context must be used
- * in multithreaded environment concurrency control must be employed.
+ * SILC Buffer is not thread-safe.  If the same SilcBuffer context must be
+ * used in multithreaded environment concurrency control must be employed.
  *
  * SOURCE
  */
@@ -270,6 +270,11 @@ SilcBuffer silc_buffer_alloc(SilcUInt32 len)
  *
  *    Frees SilcBuffer.  Can be called safely `sb' as NULL.
  *
+ * NOTES
+ *
+ *    Must not be called for buffers allocated with silc_buffer_salloc,
+ *    silc_buffer_salloc_size, silc_buffer_scopy and silc_buffer_sclone.
+ *
  ***/
 
 static inline
@@ -326,6 +331,11 @@ unsigned char *silc_buffer_steal(SilcBuffer sb, SilcUInt32 *data_len)
  *    not the buffer itself.  The `sb' remains intact, data is freed.  Buffer
  *    is ready for re-use after calling this function.
  *
+ * NOTES
+ *
+ *    Must not be called for buffers allocated with silc_buffer_salloc,
+ *    silc_buffer_salloc_size, silc_buffer_scopy and silc_buffer_sclone.
+ *
  ***/
 
 static inline