summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-11-13 12:05:09 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-11-13 12:05:09 +0900
commitb60c3fb3ba49f854167f86a29c3686b7660e7974 (patch)
tree940717bed789eaf6b0a41054dc76dbdbfd2399c5
parentdab3a6fca3732c14dec86c341948c0a24f0f1c68 (diff)
eina: Fix spelling/punctuation errors in documentation (safepointer..strbuf)
Reviewers: cedric, ajwillia.ms Subscribers: segfaultxavi, jpeg Differential Revision: https://phab.enlightenment.org/D5458
-rw-r--r--src/lib/eina/eina_safepointer.h16
-rw-r--r--src/lib/eina/eina_safety_checks.h6
-rw-r--r--src/lib/eina/eina_simple_xml_parser.h18
-rw-r--r--src/lib/eina/eina_slstr.h2
-rw-r--r--src/lib/eina/eina_str.h6
-rw-r--r--src/lib/eina/eina_strbuf.h14
6 files changed, 31 insertions, 31 deletions
diff --git a/src/lib/eina/eina_safepointer.h b/src/lib/eina/eina_safepointer.h
index 16a52ce..72bade4 100644
--- a/src/lib/eina/eina_safepointer.h
+++ b/src/lib/eina/eina_safepointer.h
@@ -24,16 +24,16 @@
24 * 24 *
25 * @brief These functions provide a wrapper that protect access to pointers 25 * @brief These functions provide a wrapper that protect access to pointers
26 * 26 *
27 * Eina_Safepointer is an pointer to index converter that allow an increased 27 * Eina_Safepointer is an pointer to index converter that allows an increased
28 * level of safety by forbidding direct access to the pointer. The protection 28 * level of safety by forbidding direct access to the pointer. The protection
29 * work by using a set of indirection table that are mmapped and mprotected 29 * works by using a set of indirection tables that are mmapped and mprotected
30 * against write access. This the pointer they store and that map to a specific 30 * against write access. Thus the pointer they store and that map to a specific
31 * index is always correct. Also once a pointer is unregistered the index 31 * index is always correct. Also once a pointer is unregistered the index
32 * won't be served back for 2^8 on 32 bits system and 2^28 on 64 bits system 32 * won't be served back for 2^8 on 32 bits system and 2^28 on 64 bits system
33 * for that specific slot. Finally we do guarantee that the lower 2 bits of the 33 * for that specific slot. Finally we guarantee that the lower 2 bits of the
34 * returned index are actually never used and completly ignored by our API. 34 * returned index are actually never used and completly ignored by our API.
35 * So you can safely store whatever information you want in it, we will ignore 35 * So you can safely store whatever information you want in it, we will ignore
36 * it and threat as if it wasn't there. 36 * it and treat as if it wasn't there.
37 * 37 *
38 * @note The use of Eina_Safepointer is thread safe. 38 * @note The use of Eina_Safepointer is thread safe.
39 */ 39 */
@@ -63,7 +63,7 @@
63typedef struct _Eina_Safepointer Eina_Safepointer; 63typedef struct _Eina_Safepointer Eina_Safepointer;
64 64
65/** 65/**
66 * @brief Register a pointer and get an Eina_Safepointer that map to it. 66 * @brief Register a pointer and get an Eina_Safepointer that maps to it.
67 * 67 *
68 * @param target The pointer to register. 68 * @param target The pointer to register.
69 * @return A valid pointer that is an index to the mapped pointer. 69 * @return A valid pointer that is an index to the mapped pointer.
@@ -72,7 +72,7 @@ typedef struct _Eina_Safepointer Eina_Safepointer;
72 * 72 *
73 * @note The lower 2 bits of the returned pointer will always be 0. 73 * @note The lower 2 bits of the returned pointer will always be 0.
74 * 74 *
75 * @note The returned pointer can be used like a pointer, but can not 75 * @note The returned pointer can be used like a pointer, but cannot
76 * be touched except with Eina_Safepointer functions. 76 * be touched except with Eina_Safepointer functions.
77 * 77 *
78 * @since 1.18 78 * @since 1.18
@@ -80,7 +80,7 @@ typedef struct _Eina_Safepointer Eina_Safepointer;
80EAPI const Eina_Safepointer *eina_safepointer_register(const void *target); 80EAPI const Eina_Safepointer *eina_safepointer_register(const void *target);
81 81
82/** 82/**
83 * @brief Unregister an Eina_Safepointer and the pointer that map to it. 83 * @brief Unregister an Eina_Safepointer and the pointer that maps to it.
84 * 84 *
85 * @param safe The index to unregister from the mapping. 85 * @param safe The index to unregister from the mapping.
86 * 86 *
diff --git a/src/lib/eina/eina_safety_checks.h b/src/lib/eina/eina_safety_checks.h
index 656054b..52d58f7 100644
--- a/src/lib/eina/eina_safety_checks.h
+++ b/src/lib/eina/eina_safety_checks.h
@@ -52,7 +52,7 @@
52 * #include <Ecore.h> 52 * #include <Ecore.h>
53 * 53 *
54 * #include <eina_safety_checks.h> 54 * #include <eina_safety_checks.h>
55 * // all these files below will NOT emit warning from EINA_ARG_NONNULL(), 55 * // all the files below will NOT emit warning from EINA_ARG_NONNULL(),
56 * // but this is required to have the functions defined there to be checked 56 * // but this is required to have the functions defined there to be checked
57 * // for NULL pointers 57 * // for NULL pointers
58 * #include "my_functions1.h" 58 * #include "my_functions1.h"
@@ -68,10 +68,10 @@
68 * that should never happen, it is similar in concept to assert(), but 68 * that should never happen, it is similar in concept to assert(), but
69 * will log and return instead of abort() your program. 69 * will log and return instead of abort() your program.
70 * 70 *
71 * Since these cases should never happen, one may wantto keep safety 71 * Since these cases should never happen, one may want to keep safety
72 * checks enabled during tests but disable then during deploy, not 72 * checks enabled during tests but disable then during deploy, not
73 * doing any checks at all. This is a common requirement for embedded 73 * doing any checks at all. This is a common requirement for embedded
74 * systems. Whenever to check or not should be set during compile time 74 * systems. When to check or not should be set during compile time
75 * by using @c --disable-safety-checks or @c --enable-safety-checks 75 * by using @c --disable-safety-checks or @c --enable-safety-checks
76 * options to @c configure script. 76 * options to @c configure script.
77 * 77 *
diff --git a/src/lib/eina/eina_simple_xml_parser.h b/src/lib/eina/eina_simple_xml_parser.h
index 85169d4..a31a14e 100644
--- a/src/lib/eina/eina_simple_xml_parser.h
+++ b/src/lib/eina/eina_simple_xml_parser.h
@@ -229,7 +229,7 @@ typedef Eina_Bool (*Eina_Simple_XML_Attribute_Cb)(void *data, const char *key, c
229 * @param func What to call back while parse to do some action. The 229 * @param func What to call back while parse to do some action. The
230 * first parameter is the given user @a data, the second is the 230 * first parameter is the given user @a data, the second is the
231 * token type, the third is the pointer to content start (it's 231 * token type, the third is the pointer to content start (it's
232 * not a NULL terminated string!), the forth is where this 232 * not a NULL terminated string!), the fourth is where this
233 * content is located inside @a buf (does not include tag 233 * content is located inside @a buf (does not include tag
234 * start, for instance "<!DOCTYPE value>" the offset points at 234 * start, for instance "<!DOCTYPE value>" the offset points at
235 * "value"), the fifth is the size of the content. Whenever this 235 * "value"), the fifth is the size of the content. Whenever this
@@ -311,7 +311,7 @@ eina_simple_xml_attribute_w3c_parse(const char *buf, Eina_Simple_XML_Attribute_C
311EAPI Eina_Simple_XML_Attribute * eina_simple_xml_attribute_new(Eina_Simple_XML_Node_Tag *parent, const char *key, const char *value); 311EAPI Eina_Simple_XML_Attribute * eina_simple_xml_attribute_new(Eina_Simple_XML_Node_Tag *parent, const char *key, const char *value);
312 312
313/** 313/**
314 * @brief Removes attribute from parent and delete it. 314 * @brief Removes attribute from parent and deletes it.
315 * 315 *
316 * @param attr attribute to release memory. 316 * @param attr attribute to release memory.
317 */ 317 */
@@ -332,7 +332,7 @@ EAPI void eina_simple_xml_attribute_free(Eina_Simple_XML_Attribute *attr);
332EAPI Eina_Simple_XML_Node_Tag * eina_simple_xml_node_tag_new(Eina_Simple_XML_Node_Tag *parent, const char *name); 332EAPI Eina_Simple_XML_Node_Tag * eina_simple_xml_node_tag_new(Eina_Simple_XML_Node_Tag *parent, const char *name);
333 333
334/** 334/**
335 * @brief Removes tag from parent and delete it. 335 * @brief Removes tag from parent and deletes it.
336 * 336 *
337 * @param tag to release memory. 337 * @param tag to release memory.
338 */ 338 */
@@ -354,7 +354,7 @@ EAPI void eina_simple_xml_node_tag_free(Eina_Simple_XML_Node_Tag *tag);
354EAPI Eina_Simple_XML_Node_Data * eina_simple_xml_node_data_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); 354EAPI Eina_Simple_XML_Node_Data * eina_simple_xml_node_data_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length);
355 355
356/** 356/**
357 * @brief Removes data from parent and delete it. 357 * @brief Removes data from parent and deletes it.
358 * 358 *
359 * @param node to release memory. 359 * @param node to release memory.
360 */ 360 */
@@ -376,7 +376,7 @@ EAPI void eina_simple_xml_node_data_free(Eina_Simple_XML_Node_Data *node);
376EAPI Eina_Simple_XML_Node_CData * eina_simple_xml_node_cdata_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); 376EAPI Eina_Simple_XML_Node_CData * eina_simple_xml_node_cdata_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length);
377 377
378/** 378/**
379 * @brief Removes cdata from parent and delete it. 379 * @brief Removes cdata from parent and deletes it.
380 * 380 *
381 * @param node to release memory. 381 * @param node to release memory.
382 */ 382 */
@@ -400,7 +400,7 @@ EAPI void eina_simple_xml_node_cdata_free(Eina_Simple_XML_Node_Data *node);
400EAPI Eina_Simple_XML_Node_Doctype_Child * eina_simple_xml_node_doctype_child_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); 400EAPI Eina_Simple_XML_Node_Doctype_Child * eina_simple_xml_node_doctype_child_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length);
401 401
402/** 402/**
403 * @brief Removes doctype child from parent and delete it. 403 * @brief Removes doctype child from parent and deletes it.
404 * 404 *
405 * @param node to release memory. 405 * @param node to release memory.
406 * 406 *
@@ -424,7 +424,7 @@ EAPI void eina_simple_xml_node_doctype_child_free(Eina_Simple_XML_Node_Data *nod
424EAPI Eina_Simple_XML_Node_Processing * eina_simple_xml_node_processing_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); 424EAPI Eina_Simple_XML_Node_Processing * eina_simple_xml_node_processing_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length);
425 425
426/** 426/**
427 * @brief Removes processing from parent and delete it. 427 * @brief Removes processing from parent and deletes it.
428 * 428 *
429 * @param node processing to release memory. 429 * @param node processing to release memory.
430 */ 430 */
@@ -446,7 +446,7 @@ EAPI void eina_simple_xml_node_processing_free(Eina_Simple_XML_Node_Data *node);
446EAPI Eina_Simple_XML_Node_Doctype * eina_simple_xml_node_doctype_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); 446EAPI Eina_Simple_XML_Node_Doctype * eina_simple_xml_node_doctype_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length);
447 447
448/** 448/**
449 * @brief Removes doctype from parent and delete it. 449 * @brief Removes doctype from parent and deletes it.
450 * 450 *
451 * @param node doctype to release memory. 451 * @param node doctype to release memory.
452 */ 452 */
@@ -468,7 +468,7 @@ EAPI void eina_simple_xml_node_doctype_free(Eina_Simple_XML_Node_Data *node);
468EAPI Eina_Simple_XML_Node_Comment * eina_simple_xml_node_comment_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); 468EAPI Eina_Simple_XML_Node_Comment * eina_simple_xml_node_comment_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length);
469 469
470/** 470/**
471 * @brief Removes comment from parent and delete it. 471 * @brief Removes comment from parent and deletes it.
472 * 472 *
473 * @param node comment to release memory. 473 * @param node comment to release memory.
474 */ 474 */
diff --git a/src/lib/eina/eina_slstr.h b/src/lib/eina/eina_slstr.h
index 0e5d66e..aa735c2 100644
--- a/src/lib/eina/eina_slstr.h
+++ b/src/lib/eina/eina_slstr.h
@@ -20,7 +20,7 @@
20 * This set of APIs provide a convenience feature to create and return strings 20 * This set of APIs provide a convenience feature to create and return strings
21 * that are meant to be consumed in the local scope of the calling code block. 21 * that are meant to be consumed in the local scope of the calling code block.
22 * The lifecycle of those strings is bound to the loop of the current thread 22 * The lifecycle of those strings is bound to the loop of the current thread
23 * or until the clear function is called explicitely. 23 * or until the clear function is called explicitly.
24 * 24 *
25 * These strings will be automatically deleted. 25 * These strings will be automatically deleted.
26 * 26 *
diff --git a/src/lib/eina/eina_str.h b/src/lib/eina/eina_str.h
index 8590845..94e986d 100644
--- a/src/lib/eina/eina_str.h
+++ b/src/lib/eina/eina_str.h
@@ -14,7 +14,7 @@
14 * @skipline #include 14 * @skipline #include
15 * @line #include 15 * @line #include
16 * 16 *
17 * In our main function we declare(and initialize) some variables and initialize 17 * In our main function we declare (and initialize) some variables and initialize
18 * eina: 18 * eina:
19 * @until eina_init 19 * @until eina_init
20 * 20 *
@@ -31,7 +31,7 @@
31 * values: 31 * values:
32 * @until Has 32 * @until Has
33 * 33 *
34 * When strings will be used in a terminal(or a number of other places) it 34 * When strings will be used in a terminal (or a number of other places) it
35 * necessary to escape certain characters that appear in them: 35 * necessary to escape certain characters that appear in them:
36 * @until printf 36 * @until printf
37 * 37 *
@@ -201,7 +201,7 @@ EAPI char **eina_str_split(const char *string, const char *delimiter, i
201 * This function splits @p string into a maximum of @p max_tokens pieces, 201 * This function splits @p string into a maximum of @p max_tokens pieces,
202 * using the given delimiter @p delimiter. @p delimiter is not included in any 202 * using the given delimiter @p delimiter. @p delimiter is not included in any
203 * of the resulting strings, unless @p max_tokens is reached. If 203 * of the resulting strings, unless @p max_tokens is reached. If
204 * @p max_tokens is less than @c 1, the string is splitted as many times as possible. If 204 * @p max_tokens is less than @c 1, the string is split as many times as possible. If
205 * @p max_tokens is reached, the last string in the returned string 205 * @p max_tokens is reached, the last string in the returned string
206 * array contains the remainder of string. The returned value is a 206 * array contains the remainder of string. The returned value is a
207 * newly allocated NULL-terminated array of strings or @c NULL if it fails to 207 * newly allocated NULL-terminated array of strings or @c NULL if it fails to
diff --git a/src/lib/eina/eina_strbuf.h b/src/lib/eina/eina_strbuf.h
index 49b83e0..b5f05af 100644
--- a/src/lib/eina/eina_strbuf.h
+++ b/src/lib/eina/eina_strbuf.h
@@ -82,7 +82,7 @@ EAPI Eina_Strbuf *eina_strbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
82/** 82/**
83 * @brief Creates a new string buffer using the passed string. The passed 83 * @brief Creates a new string buffer using the passed string. The passed
84 * string is used directly as the buffer, it's somehow the opposite function of 84 * string is used directly as the buffer, it's somehow the opposite function of
85 * @ref eina_strbuf_string_steal . The passed string must be malloced. 85 * @ref eina_strbuf_string_steal . The passed string must be malloc'd.
86 * 86 *
87 * @param str The string to manage 87 * @param str The string to manage
88 * @return Newly allocated string buffer instance. 88 * @return Newly allocated string buffer instance.
@@ -100,7 +100,7 @@ EAPI Eina_Strbuf *eina_strbuf_manage_new(char *str) EINA_MALLOC EINA_WARN_UNUSED
100/** 100/**
101 * @brief Creates a new string buffer using the passed string. The passed 101 * @brief Creates a new string buffer using the passed string. The passed
102 * string is used directly as the buffer, it's somehow the opposite function of 102 * string is used directly as the buffer, it's somehow the opposite function of
103 * @ref eina_strbuf_string_steal . The passed string must be malloced. 103 * @ref eina_strbuf_string_steal . The passed string must be malloc'd.
104 * 104 *
105 * @param str The string to manage 105 * @param str The string to manage
106 * @param length The length of the string. 106 * @param length The length of the string.
@@ -117,7 +117,7 @@ EAPI Eina_Strbuf *eina_strbuf_manage_new_length(char *str, size_t length) EINA_M
117/** 117/**
118 * @brief Creates a new string buffer using the passed string. The passed 118 * @brief Creates a new string buffer using the passed string. The passed
119 * string is used directly as the buffer, it's somehow the opposite function of 119 * string is used directly as the buffer, it's somehow the opposite function of
120 * @ref eina_strbuf_string_steal . The passed string must be malloced. 120 * @ref eina_strbuf_string_steal . The passed string must be malloc'd.
121 * 121 *
122 * @param str The string to manage 122 * @param str The string to manage
123 * @param length The length of the string. 123 * @param length The length of the string.
@@ -411,7 +411,7 @@ EAPI Eina_Bool eina_strbuf_insert_char(Eina_Strbuf *buf, char c, size_t pos) EIN
411 * @param pos The position to insert the string. 411 * @param pos The position to insert the string.
412 * @return #EINA_TRUE on success, #EINA_FALSE on failure. 412 * @return #EINA_TRUE on success, #EINA_FALSE on failure.
413 * 413 *
414 * This function insert a string as described by the format @p fmt to @p buf at 414 * This function inserts a string as described by the format @p fmt to @p buf at
415 * the position @p pos. @p fmt must be of a valid format for printf family of 415 * the position @p pos. @p fmt must be of a valid format for printf family of
416 * functions. If it can't insert it, #EINA_FALSE is returned, 416 * functions. If it can't insert it, #EINA_FALSE is returned,
417 * otherwise #EINA_TRUE is returned. 417 * otherwise #EINA_TRUE is returned.
@@ -632,11 +632,11 @@ EAPI Eina_Bool eina_strbuf_replace(Eina_Strbuf *buf, const char *str, const char
632 632
633 633
634/** 634/**
635 * @brief Replaces all strings with an other string. 635 * @brief Replaces all strings with another string.
636 636
637 * @param buf The string buffer to work with. 637 * @param buf The string buffer to work with.
638 * @param str The string to replace. 638 * @param str The string to replace.
639 * @param with The replacing string. 639 * @param with The replacement string.
640 * @return How often the string was replaced. 640 * @return How often the string was replaced.
641 * 641 *
642 * This function replaces all the occurrences of @p str in @p buf with 642 * This function replaces all the occurrences of @p str in @p buf with
@@ -650,7 +650,7 @@ EAPI int eina_strbuf_replace_all(Eina_Strbuf *buf, const char *str, const char *
650 650
651 * @param buf The string buffer to work with. 651 * @param buf The string buffer to work with.
652 * 652 *
653 * This function skips whitespaces in the beginning and the end of the buffer. 653 * This function skips whitespaces at the beginning and the end of the buffer.
654 */ 654 */
655EAPI void eina_strbuf_trim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); 655EAPI void eina_strbuf_trim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
656 656