Added SilcStack support to SILC File Util API.

[silc.git] / lib / silcutil / silcbuffer.h

diff --git a/lib/silcutil/silcbuffer.h b/lib/silcutil/silcbuffer.h
index 5ce671175b628994820e5edd63a20efb026cb504..7dec1149a21a5d7b3163ca8368acba4da9eed306 100644 (file)
--- a/lib/silcutil/silcbuffer.h
+++ b/lib/silcutil/silcbuffer.h
@@ -961,6 +961,9 @@ SilcBool silc_buffer_enlarge(SilcBuffer sb, SilcUInt32 size)
  *    This routine use SilcStack are memory source.  If `stack' is NULL
  *    reverts back to normal allocating routine.
  *
+ *    Note that this call consumes the `stack'.  The caller should push the
+ *    stack before calling the function and pop it later.
+ *
  ***/
 
 static inline
@@ -1005,6 +1008,9 @@ SilcBuffer silc_buffer_salloc(SilcStack stack, SilcUInt32 len)
  *    This routine use SilcStack are memory source.  If `stack' is NULL
  *    reverts back to normal allocating routine.
  *
+ *    Note that this call consumes the `stack'.  The caller should push the
+ *    stack before calling the function and pop it later.
+ *
  ***/
 
 static inline
@@ -1034,6 +1040,9 @@ SilcBuffer silc_buffer_salloc_size(SilcStack stack, SilcUInt32 len)
  *    This routine use SilcStack are memory source.  If `stack' is NULL
  *    reverts back to normal allocating routine.
  *
+ *    Note that this call consumes the `stack'.  The caller should push the
+ *    stack before calling the function and pop it later.
+ *
  ***/
 
 static inline
@@ -1090,6 +1099,9 @@ SilcBuffer silc_buffer_srealloc(SilcStack stack,
  *    This routine use SilcStack are memory source.  If `stack' is NULL
  *    reverts back to normal allocating routine.
  *
+ *    Note that this call consumes the `stack'.  The caller should push the
+ *    stack before calling the function and pop it later.
+ *
  ***/
 
 static inline
@@ -1124,6 +1136,9 @@ SilcBuffer silc_buffer_srealloc_size(SilcStack stack,
  *    This routine use SilcStack are memory source.  If `stack' is NULL
  *    reverts back to normal allocating routine.
  *
+ *    Note that this call consumes the `stack'.  The caller should push the
+ *    stack before calling the function and pop it later.
+ *
  ***/
 
 static inline
@@ -1157,6 +1172,9 @@ SilcBool silc_buffer_senlarge(SilcStack stack, SilcBuffer sb, SilcUInt32 size)
  *    This routine use SilcStack are memory source.  If `stack' is NULL
  *    reverts back to normal allocating routine.
  *
+ *    Note that this call consumes the `stack'.  The caller should push the
+ *    stack before calling the function and pop it later.
+ *
  ***/
 
 static inline
@@ -1188,6 +1206,9 @@ SilcBuffer silc_buffer_scopy(SilcStack stack, SilcBuffer sb)
  *    This routine use SilcStack are memory source.  If `stack' is NULL
  *    reverts back to normal allocating routine.
  *
+ *    Note that this call consumes the `stack'.  The caller should push the
+ *    stack before calling the function and pop it later.
+ *
  ***/
 
 static inline