From 7e277d8a8b029c4cb73b3b7d4bd8865546119000 Mon Sep 17 00:00:00 2001 From: John Marshall Date: Wed, 24 Jul 2013 14:30:57 +0100 Subject: [PATCH] Add kstring_t init/destroy documentation Ideally these could be provided as ks_init()/ks_destroy(), but those names are already in use with kstream_t. --- kstring.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/kstring.h b/kstring.h index 360a598..1145c48 100644 --- a/kstring.h +++ b/kstring.h @@ -43,6 +43,15 @@ #endif +/* kstring_t is a simple non-opaque type whose fields are likely to be + * used directly by user code (but see also ks_str() and ks_len() below). + * A kstring_t object is initialised by either of + * kstring_t str = { 0, 0, NULL }; + * kstring_t str; ...; str.l = str.m = 0; str.s = NULL; + * and either ownership of the underlying buffer should be given away before + * the object disappears (i.e., the str.s pointer copied and something else + * responsible for freeing it), or the kstring_t should be destroyed with + * free(str.s); */ #ifndef KSTRING_T #define KSTRING_T kstring_t typedef struct __kstring_t { -- 2.47.3