ajwillia-ms pushed a commit to branch master.

http://git.enlightenment.org/core/efl.git/commit/?id=63c6724f089c75a8fde62b1f160f2b25382bca16

commit 63c6724f089c75a8fde62b1f160f2b25382bca16
Author: Andy Williams <[email protected]>
Date:   Thu Nov 16 12:49:56 2017 +0000

    eina: fix docs for manage_read_only_new
---
 src/lib/eina/eina_strbuf.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/lib/eina/eina_strbuf.h b/src/lib/eina/eina_strbuf.h
index b5f05aff88..b65e8b1d27 100644
--- a/src/lib/eina/eina_strbuf.h
+++ b/src/lib/eina/eina_strbuf.h
@@ -117,7 +117,9 @@ EAPI Eina_Strbuf *eina_strbuf_manage_new_length(char *str, 
size_t length) EINA_M
 /**
  * @brief Creates a new string buffer using the passed string. The passed
  * string is used directly as the buffer, it's somehow the opposite function of
- * @ref eina_strbuf_string_steal . The passed string must be malloc'd.
+ * @ref eina_strbuf_string_steal . The passed string is expected to be static 
or
+ * otherwise on the stack rather than the malloc'd string required by
+ * @ref eina_strbuf_manage_new_length .
  *
  * @param str The string to manage
  * @param length The length of the string.
@@ -127,6 +129,7 @@ EAPI Eina_Strbuf *eina_strbuf_manage_new_length(char *str, 
size_t length) EINA_M
  * returned. To free the resources, use eina_strbuf_free().
  *
  * @see eina_strbuf_manage_new()
+ * @see eina_strbuf_manage_new_length()
  * @since 1.9.0
  */
 EAPI Eina_Strbuf *eina_strbuf_manage_read_only_new_length(const char *str, 
size_t length) EINA_MALLOC EINA_WARN_UNUSED_RESULT;

-- 


Reply via email to