From 70bf8d90605bf4c1fe93bf9773ba017defeeadf7 Mon Sep 17 00:00:00 2001 From: gastal Date: Wed, 22 Feb 2012 13:35:01 +0000 Subject: [PATCH] Stringshare doc additions. git-svn-id: http://svn.enlightenment.org/svn/e/trunk/eina@68271 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- src/include/eina_stringshare.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/include/eina_stringshare.h b/src/include/eina_stringshare.h index 934fb40..8edadd2 100644 --- a/src/include/eina_stringshare.h +++ b/src/include/eina_stringshare.h @@ -126,6 +126,20 @@ * string creation/destruction speed, reduces memory use and decreases * memory fragmentation, so a win all-around. * + * Using eina stringshares usually boils down to: + * @code + * const char *str = eina_stringshare_add("My string"); + * ... + * //Use str + * ... + * eina_stringshare_del(str); + * @endcode + * @note It's very important to note that string shares are @b @c const, + * changing them will result in undefined behavior. + * @note eina_stringshare_del() @b doesn't guarantee the string share will be + * freed, it releases a reference to it, but if other references to it still + * exist the string share will live until those are released. + * * The following diagram gives an idea of what happens as you create strings * with eina_stringshare_add(): * -- 2.7.4