kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

eina: Fix spelling/punctuation errors in documentation (safepointer..strbuf) 

Reviewers: cedric, ajwillia.ms

Subscribers: segfaultxavi, jpeg

Differential Revision: https://phab.enlightenment.org/D5458
This commit is contained in:
Bryce Harrington 2017-11-13 12:05:09 +09:00 committed by Jean-Philippe Andre
parent dab3a6fca3
commit b60c3fb3ba
6 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/lib/eina/eina_safepointer.h
View File

@ -24,16 +24,16 @@
*
* @brief These functions provide a wrapper that protect access to pointers
*
* Eina_Safepointer is an pointer to index converter that allow an increased
* Eina_Safepointer is an pointer to index converter that allows an increased
* level of safety by forbidding direct access to the pointer. The protection
* work by using a set of indirection table that are mmapped and mprotected
* against write access. This the pointer they store and that map to a specific
* works by using a set of indirection tables that are mmapped and mprotected
* against write access. Thus the pointer they store and that map to a specific
* index is always correct. Also once a pointer is unregistered the index
* won't be served back for 2^8 on 32 bits system and 2^28 on 64 bits system
* for that specific slot. Finally we do guarantee that the lower 2 bits of the
* for that specific slot. Finally we guarantee that the lower 2 bits of the
* returned index are actually never used and completly ignored by our API.
* So you can safely store whatever information you want in it, we will ignore
* it and threat as if it wasn't there.
* it and treat as if it wasn't there.
*
* @note The use of Eina_Safepointer is thread safe.
*/
@ -63,7 +63,7 @@
typedef struct _Eina_Safepointer Eina_Safepointer;
/**
* @brief Register a pointer and get an Eina_Safepointer that map to it.
* @brief Register a pointer and get an Eina_Safepointer that maps to it.
*
* @param target The pointer to register.
* @return A valid pointer that is an index to the mapped pointer.
@ -72,7 +72,7 @@ typedef struct _Eina_Safepointer Eina_Safepointer;
*
* @note The lower 2 bits of the returned pointer will always be 0.
*
* @note The returned pointer can be used like a pointer, but can not
* @note The returned pointer can be used like a pointer, but cannot
* be touched except with Eina_Safepointer functions.
*
* @since 1.18
@ -80,7 +80,7 @@ typedef struct _Eina_Safepointer Eina_Safepointer;
EAPI const Eina_Safepointer *eina_safepointer_register(const void *target);
/**
* @brief Unregister an Eina_Safepointer and the pointer that map to it.
* @brief Unregister an Eina_Safepointer and the pointer that maps to it.
*
* @param safe The index to unregister from the mapping.
*

6
src/lib/eina/eina_safety_checks.h
View File

@ -52,7 +52,7 @@
* #include <Ecore.h>
*
* #include <eina_safety_checks.h>
* // all these files below will NOT emit warning from EINA_ARG_NONNULL(),
* // all the files below will NOT emit warning from EINA_ARG_NONNULL(),
* // but this is required to have the functions defined there to be checked
* // for NULL pointers
* #include "my_functions1.h"
@ -68,10 +68,10 @@
* that should never happen, it is similar in concept to assert(), but
* will log and return instead of abort() your program.
*
* Since these cases should never happen, one may wantto keep safety
* Since these cases should never happen, one may want to keep safety
* checks enabled during tests but disable then during deploy, not
* doing any checks at all. This is a common requirement for embedded
* systems. Whenever to check or not should be set during compile time
* systems. When to check or not should be set during compile time
* by using @c --disable-safety-checks or @c --enable-safety-checks
* options to @c configure script.
*

18
src/lib/eina/eina_simple_xml_parser.h
View File

@ -229,7 +229,7 @@ typedef Eina_Bool (*Eina_Simple_XML_Attribute_Cb)(void *data, const char *key, c
* @param func What to call back while parse to do some action. The
* first parameter is the given user @a data, the second is the
* token type, the third is the pointer to content start (it's
* not a NULL terminated string!), the forth is where this
* not a NULL terminated string!), the fourth is where this
* content is located inside @a buf (does not include tag
* start, for instance "<!DOCTYPE value>" the offset points at
* "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
EAPI Eina_Simple_XML_Attribute * eina_simple_xml_attribute_new(Eina_Simple_XML_Node_Tag *parent, const char *key, const char *value);
/**
* @brief Removes attribute from parent and delete it.
* @brief Removes attribute from parent and deletes it.
*
* @param attr attribute to release memory.
*/
@ -332,7 +332,7 @@ EAPI void eina_simple_xml_attribute_free(Eina_Simple_XML_Attribute *attr);
EAPI Eina_Simple_XML_Node_Tag * eina_simple_xml_node_tag_new(Eina_Simple_XML_Node_Tag *parent, const char *name);
/**
* @brief Removes tag from parent and delete it.
* @brief Removes tag from parent and deletes it.
*
* @param tag to release memory.
*/
@ -354,7 +354,7 @@ EAPI void eina_simple_xml_node_tag_free(Eina_Simple_XML_Node_Tag *tag);
EAPI Eina_Simple_XML_Node_Data * eina_simple_xml_node_data_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length);
/**
* @brief Removes data from parent and delete it.
* @brief Removes data from parent and deletes it.
*
* @param node to release memory.
*/
@ -376,7 +376,7 @@ EAPI void eina_simple_xml_node_data_free(Eina_Simple_XML_Node_Data *node);
EAPI Eina_Simple_XML_Node_CData * eina_simple_xml_node_cdata_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length);
/**
* @brief Removes cdata from parent and delete it.
* @brief Removes cdata from parent and deletes it.
*
* @param node to release memory.
*/
@ -400,7 +400,7 @@ EAPI void eina_simple_xml_node_cdata_free(Eina_Simple_XML_Node_Data *node);
EAPI 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);
/**
* @brief Removes doctype child from parent and delete it.
* @brief Removes doctype child from parent and deletes it.
*
* @param node to release memory.
*
@ -424,7 +424,7 @@ EAPI void eina_simple_xml_node_doctype_child_free(Eina_Simple_XML_Node_Data *nod
EAPI Eina_Simple_XML_Node_Processing * eina_simple_xml_node_processing_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length);
/**
* @brief Removes processing from parent and delete it.
* @brief Removes processing from parent and deletes it.
*
* @param node processing to release memory.
*/
@ -446,7 +446,7 @@ EAPI void eina_simple_xml_node_processing_free(Eina_Simple_XML_Node_Data *node);
EAPI Eina_Simple_XML_Node_Doctype * eina_simple_xml_node_doctype_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length);
/**
* @brief Removes doctype from parent and delete it.
* @brief Removes doctype from parent and deletes it.
*
* @param node doctype to release memory.
*/
@ -468,7 +468,7 @@ EAPI void eina_simple_xml_node_doctype_free(Eina_Simple_XML_Node_Data *node);
EAPI Eina_Simple_XML_Node_Comment * eina_simple_xml_node_comment_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length);
/**
* @brief Removes comment from parent and delete it.
* @brief Removes comment from parent and deletes it.
*
* @param node comment to release memory.
*/

2
src/lib/eina/eina_slstr.h
View File

@ -20,7 +20,7 @@
* This set of APIs provide a convenience feature to create and return strings
* that are meant to be consumed in the local scope of the calling code block.
* The lifecycle of those strings is bound to the loop of the current thread
* or until the clear function is called explicitely.
* or until the clear function is called explicitly.
*
* These strings will be automatically deleted.
*

6
src/lib/eina/eina_str.h
View File

@ -14,7 +14,7 @@
* @skipline #include
* @line #include
*
* In our main function we declare(and initialize) some variables and initialize
* In our main function we declare (and initialize) some variables and initialize
* eina:
* @until eina_init
*
@ -31,7 +31,7 @@
* values:
* @until Has
*
* When strings will be used in a terminal(or a number of other places) it
* When strings will be used in a terminal (or a number of other places) it
* necessary to escape certain characters that appear in them:
* @until printf
*
@ -201,7 +201,7 @@ EAPI char **eina_str_split(const char *string, const char *delimiter, i
* This function splits @p string into a maximum of @p max_tokens pieces,
* using the given delimiter @p delimiter. @p delimiter is not included in any
* of the resulting strings, unless @p max_tokens is reached. If
* @p max_tokens is less than @c 1, the string is splitted as many times as possible. If
* @p max_tokens is less than @c 1, the string is split as many times as possible. If
* @p max_tokens is reached, the last string in the returned string
* array contains the remainder of string. The returned value is a
* newly allocated NULL-terminated array of strings or @c NULL if it fails to

14
src/lib/eina/eina_strbuf.h
View File

@ -82,7 +82,7 @@ EAPI Eina_Strbuf *eina_strbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
/**
* @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 malloced.
* @ref eina_strbuf_string_steal . The passed string must be malloc'd.
*
* @param str The string to manage
* @return Newly allocated string buffer instance.
@ -100,7 +100,7 @@ EAPI Eina_Strbuf *eina_strbuf_manage_new(char *str) EINA_MALLOC EINA_WARN_UNUSED
/**
* @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 malloced.
* @ref eina_strbuf_string_steal . The passed string must be malloc'd.
*
* @param str The string to manage
* @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
/**
* @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 malloced.
* @ref eina_strbuf_string_steal . The passed string must be malloc'd.
*
* @param str The string to manage
* @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
* @param pos The position to insert the string.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This function insert a string as described by the format @p fmt to @p buf at
* This function inserts a string as described by the format @p fmt to @p buf at
* the position @p pos. @p fmt must be of a valid format for printf family of
* functions. If it can't insert it, #EINA_FALSE is returned,
* otherwise #EINA_TRUE is returned.
@ -632,11 +632,11 @@ EAPI Eina_Bool eina_strbuf_replace(Eina_Strbuf *buf, const char *str, const char
/**
* @brief Replaces all strings with an other string.
* @brief Replaces all strings with another string.
* @param buf The string buffer to work with.
* @param str The string to replace.
* @param with The replacing string.
* @param with The replacement string.
* @return How often the string was replaced.
*
* 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 *
* @param buf The string buffer to work with.
*
* This function skips whitespaces in the beginning and the end of the buffer.
* This function skips whitespaces at the beginning and the end of the buffer.
*/
EAPI void eina_strbuf_trim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);