* container is locked calling eina_accessor_over() on it will return
* immediately. If @p accessor is @c NULL or if a problem occurred, #EINA_FALSE
* is returned, otherwise #EINA_TRUE is returned. If the container isn't
- * lockable, it will return EINA_TRUE.
+ * lockable, it will return #EINA_TRUE.
*
* @warning None of the existing eina data structures are lockable.
*/
* If the container of the @p accessor permits it and was previously
* locked, it will be unlocked. If @p accessor is @c NULL or if a
* problem occurred, #EINA_FALSE is returned, otherwise #EINA_TRUE
- * is returned. If the container is not lockable, it will return
- * EINA_TRUE.
+ * is returned. If the container is not lockable, it will
+ * return #EINA_TRUE.
*
* @warning None of the existing eina data structures are lockable.
*/
* @param array The array.
* @param keep The functions which selects the data to keep.
* @param gdata The data to pass to the function keep.
- * @return #EINA_TRUE on success, #EINA_FALSE oterwise.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function rebuilds @p array be specifying the elements to keep with the
* function @p keep. No empty/invalid fields are left in the array. @p gdata is
*
* This function returns a newly allocated iterator associated to
* @p array. If @p array is @c NULL or the count member of @p array is
- * less or equal than 0, this function returns NULL. If the memory can
+ * less or equal than 0, this function returns @c NULL. If the memory can
* not be allocated, NULL is returned and #EINA_ERROR_OUT_OF_MEMORY is
* set. Otherwise, a valid iterator is returned.
*/
*
* This function returns a newly allocated accessor associated to
* @p array. If @p array is @c NULL or the count member of @p array is
- * less or equal than 0, this function returns NULL. If the memory can
- * not be allocated, NULL is returned and #EINA_ERROR_OUT_OF_MEMORY is
+ * less or equal than 0, this function returns @c NULL. If the memory can
+ * not be allocated, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY is
* set. Otherwise, a valid accessor is returned.
*/
EAPI Eina_Accessor *eina_array_accessor_new(const Eina_Array *array) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
* @param array The array to iterate over.
* @param cb The callback to call for each item.
* @param fdata The user data to pass to the callback.
- * @return EINA_TRUE if it successfully iterate all items of the array.
+ * @return #EINA_TRUE if it successfully iterate all items of the array.
*
* This function provide a safe way to iterate over an array. @p cb should
- * return EINA_TRUE as long as you want the function to continue iterating,
- * by returning EINA_FALSE it will stop and return EINA_FALSE as a result.
+ * return #EINA_TRUE as long as you want the function to continue iterating,
+ * by returning #EINA_FALSE it will stop and return #EINA_FALSE as a result.
*/
static inline Eina_Bool eina_array_foreach(Eina_Array *array,
Eina_Each_Cb cb,
*
* This function decreases the reference counter associated to @p obj
* if it exists. If that counter reaches 0, the memory associated to
- * @p obj is freed. If @p obj is NULL, the function returns
+ * @p obj is freed. If @p obj is @c NULL, the function returns
* immediately.
*
* Note that if the given pointer is not shared or NULL, bad things
* @brief Note that the given object @b must be shared.
*
* @param obj the shared object to know the length. It is safe to
- * give NULL, in that case -1 is returned.
+ * give @c NULL, in that case @c -1 is returned.
* @return The length of the shared object.
*
* This function is a cheap way to known the length of a shared
* @param list The list
* @param elem An element
* @pre @a elem is in @a list
- * @return The element after @a elem in @a list or @c NULL if @a elem is last in @a list
+ * @return The element after @a elem in @a list or @c NULL if @a elem is last in @a list.
* @since 1.1.0
*/
static inline Eina_Clist *eina_clist_next(const Eina_Clist *list, const Eina_Clist *elem);
* @param list The list
* @param elem An element
*
- * @return The element before @a elem or NULL if @a elem is the first in the list
+ * @return The element before @a elem or @c NULL if @a elem is the first in the list.
* @since 1.1.0
*/
static inline Eina_Clist *eina_clist_prev(const Eina_Clist *list, const Eina_Clist *elem);
* Get the first element.
*
* @param list The list
- * @returns The first element in @a list or NULL if @a list is empty
+ * @returns The first element in @a list or @c NULL if @a list is empty.
* @since 1.1.0
*/
static inline Eina_Clist *eina_clist_head(const Eina_Clist *list);
* Get the last element.
*
* @param list The list
- * @returns The last element in @a list or NULL if @a list is empty
+ * @returns The last element in @a list or @c NULL if @a list is empty.
* @since 1.1.0
*/
static inline Eina_Clist *eina_clist_tail(const Eina_Clist *list);
* @param msg The description of the error. This string will be
* duplicated only if the error was registered with @ref eina_error_msg_register
* otherwise it must remain intact for the duration.
- * @return EINA_TRUE if successful, EINA_FALSE on error
+ * @return #EINA_TRUE if successful, #EINA_FALSE on error.
*
* This function modifies the message associated with @p error and changes
* it to @p msg. If the error was previously registered by @ref eina_error_msg_static_register
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function calls @p cb for each file that is in @p dir. To have @p cb
- * called on files that are in subdirectories of @p dir @p recursive should be
- * EINA_TRUE. In other words if @p recursive is EINA_FALSE, only direct children
- * of @p dir will be operated on, if @p recursive is EINA_TRUE the entire tree
+ * called on files that are in subdirectories of @p dir @p recursive should
+ * be #EINA_TRUE. In other words if @p recursive is #EINA_FALSE, only direct children
+ * of @p dir will be operated on, if @p recursive is #EINA_TRUE the entire tree
* of files that is below @p dir will be operated on.
*
* If @p cb or @p dir are @c NULL, or if @p dir is a string of size 0,
*
* @param dir The name of the directory to list
* @return Return an Eina_Iterator that will walk over the files and directories
- * in @p dir. On failure it will return NULL.
+ * in @p dir. On failure it will return @c NULL.
*
* Returns an iterator for shared strings, the name of each file in @p dir will
* only be fetched when advancing the iterator, which means there is very little
* @param container The container returned by the Eina_Iterator using eina_iterator_container_get().
* @param info The content of the current Eina_File_Direct_Info provided by the Eina_Iterator
* @param buf Where to put the result of the stat
- * @return On success 0 is returned, On error -1 is returned and errno is set appropriately.
+ * @return On success @c 0 is returned, On error @c -1 is returned and errno is set appropriately.
*
* This function calls fstatat or stat depending on what your system supports. This makes it efficient and simple
* to use on your side without complex detection already done inside Eina on what the system can do.
*
* @return Return an Eina_Iterator that will walk over the files and
* directory in the pointed directory. On failure it will
- * return NULL.
+ * return @c NULL.
*
* Returns an iterator for Eina_File_Direct_Info, the name of each file in @p
* dir will only be fetched when advancing the iterator, which means there is
* @return Eina_File handle to the file
*
* Opens a file in read-only mode. @p name should be an absolute path. An
- * Eina_File handle can be shared among multiple instances if @p shared is
- * EINA_TRUE.
+ * Eina_File handle can be shared among multiple instances if @p shared
+ * is #EINA_TRUE.
*
* @since 1.1
*/
* @param hash The given hash table.
* @param old_key The current key associated with the data
* @param new_key The new key to associate data with
- * @return EINA_FALSE in any case but success, EINA_TRUE on success.
+ * @return #EINA_FALSE in any case but success, #EINA_TRUE on success.
*
* This function allows for the move of data from one key to another,
* but does not call the Eina_Free_Cb associated with the hash table
* @return The number of entries in the hash table.
*
* This function returns the number of entries in @p hash, or 0 on
- * error. If @p hash is @c NULL, 0 is returned.
+ * error. If @p hash is @c NULL, @c 0 is returned.
*/
EAPI int eina_hash_population(const Eina_Hash *hash) EINA_ARG_NONNULL(1);
* valid iterator that will always return false on
* eina_iterator_next(), thus keeping API sane.
*
- * If the memory can not be allocated, NULL is returned
+ * If the memory can not be allocated, @c NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
*
* This function goes through every entry in the hash table @p hash and calls
* the function @p func on each member. The function should @b not modify the
- * hash table contents if it returns 1. @b If the hash table contents are
+ * hash table contents if it returns @c 1. @b If the hash table contents are
* modified by this function or the function wishes to stop processing it must
- * return 0, otherwise return 1 to keep processing.
+ * return @c 0, otherwise return @c 1 to keep processing.
*
* Example:
* @code
* @param step when resizing the array, do this using the following
* extra amount.
*
- * Initialize array. If the @a step is 0, then a safe default is
+ * Initialize array. If the @a step is @c 0, then a safe default is
* chosen.
*
* This is useful for arrays inlined into other structures or
* @param array array object
* @param data data to be copied
* @param compare compare function
- * @return the index of the new member or -1 on errors.
+ * @return the index of the new member or @c -1 on errors.
*
* Copies the given pointer contents at the array position defined by
* given @a compare function. The pointer is not referenced, instead
* @param array array object
* @param data data to be copied
* @param compare compare function
- * @return the index of the new member or -1 on errors.
+ * @return the index of the new member or @c -1 on errors.
*
* Copies the given pointer contents at the array position defined by
* given @a compare function. The pointer is not referenced, instead
* @brief Find data and remove matching member
* @param array array object
* @param data data to be found and removed
- * @return the index of the removed member or -1 on errors.
+ * @return the index of the removed member or @c -1 on errors.
*
* Find data in the array and remove it. Data may be an existing
* member of array (then optimized) or the contents will be matched
* @param array array object
* @param data member to search using @a compare function.
* @param compare compare function
- * @return the member index or -1 if not found.
+ * @return the member index or @c -1 if not found.
*
* Uses binary search for given data as compared by @a compare function.
*
* This function returns a newly allocated iterator associated to
* @p array.
*
- * If the memory can not be allocated, NULL is returned
+ * If the memory can not be allocated, @c NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
*
* Unlike eina_inarray_iterator_new(), this will walk the array backwards.
*
- * If the memory can not be allocated, NULL is returned
+ * If the memory can not be allocated, @c NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* This function returns a newly allocated accessor associated to
* @p array.
*
- * If the memory can not be allocated, NULL is returned
+ * If the memory can not be allocated, @c NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid accessor is
* returned.
*
* stringshare handle.
* @param news new string to be stringshared, may be @c NULL.
*
- * @return #EINA_TRUE if the strings were different and thus replaced,
- * #EINA_FALSE if the strings were the same after shared.
+ * @return #EINA_TRUE if the strings were different and thus replaced, #EINA_FALSE
+ * if the strings were the same after shared.
*/
static inline Eina_Bool
eina_stringshare_replace(Eina_Stringshare **p_str, const char *news)
* @param news new string to be stringshared, may be @c NULL.
* @param slen The string size (<= strlen(str)).
*
- * @return #EINA_TRUE if the strings were different and thus replaced,
- * #EINA_FALSE if the strings were the same after shared.
+ * @return #EINA_TRUE if the strings were different and thus replaced, #EINA_FALSE
+ * if the strings were the same after shared.
*/
static inline Eina_Bool
eina_stringshare_replace_length(Eina_Stringshare **p_str, const char *news, unsigned int slen)
* This function just set to zero the trash to correctly
* initialize it.
*
- * @note You can just set *trash to NULL and you will have
+ * @note You can just set *trash to @c NULL and you will have
* the same result.
*/
static inline void
* stringshare handle.
* @param news new string to be stringshared, may be @c NULL.
*
- * @return #EINA_TRUE if the strings were different and thus replaced,
- * #EINA_FALSE if the strings were the same after shared.
+ * @return #EINA_TRUE if the strings were different and thus replaced, #EINA_FALSE
+ * if the strings were the same after shared.
*/
static inline Eina_Bool
eina_ustringshare_replace(const Eina_Unicode **p_str, const Eina_Unicode *news)
* @param news new string to be stringshared, may be @c NULL.
* @param slen The string size (<= strlen(str)).
*
- * @return #EINA_TRUE if the strings were different and thus replaced,
- * #EINA_FALSE if the strings were the same after shared.
+ * @return #EINA_TRUE if the strings were different and thus replaced, #EINA_FALSE
+ * if the strings were the same after shared.
*/
static inline Eina_Bool
eina_ustringshare_replace_length(const Eina_Unicode **p_str, const Eina_Unicode *news, unsigned int slen)
* check of @a new_l prev and next pointers is done, so it's safe
* to have them uninitialized.
*
- * @param in_list existing list head or NULL to create a new list.
- * @param in_item new list node, must not be NULL.
+ * @param in_list existing list head or @c NULL to create a new list.
+ * @param in_item new list node, must not be @c NULL.
*
* @return the new list head. Use it and not @a in_list anymore.
*/
* check of @a new_l prev and next pointers is done, so it's safe
* to have them uninitialized.
*
- * @param in_list existing list head or NULL to create a new list.
- * @param in_item new list node, must not be NULL.
+ * @param in_list existing list head or @c NULL to create a new list.
+ * @param in_item new list node, must not be @c NULL.
*
* @return the new list head. Use it and not @a in_list anymore.
*/
* will lead to problems. Giving NULL @a in_relative is the same as
* eina_list_append().
*
- * @param in_list existing list head or NULL to create a new list.
- * @param in_item new list node, must not be NULL.
+ * @param in_list existing list head or @c NULL to create a new list.
+ * @param in_item new list node, must not be @c NULL.
* @param in_relative reference node, @a in_item will be added after it.
*
* @return the new list head. Use it and not @a list anymore.
* will lead to problems. Giving NULL @a in_relative is the same as
* eina_list_prepend().
*
- * @param in_list existing list head or NULL to create a new list.
- * @param in_item new list node, must not be NULL.
+ * @param in_list existing list head or @c NULL to create a new list.
+ * @param in_item new list node, must not be @c NULL.
* @param in_relative reference node, @a in_item will be added before it.
*
* @return the new list head. Use it and not @a in_list anymore.
* it will be different from @a list and the wrong new head will
* be returned.
*
- * @param in_list existing list head, must not be NULL.
- * @param in_item existing list node, must not be NULL.
+ * @param in_list existing list head, must not be @c NULL.
+ * @param in_item existing list node, must not be @c NULL.
*
* @return the new list head. Use it and not @a list anymore.
*/
* @warning this is an expensive call and has O(n) cost, possibly
* walking the whole list.
*
- * @param in_list existing list to search @a in_item in, must not be NULL.
- * @param in_item what to search for, must not be NULL.
+ * @param in_list existing list to search @a in_item in, must not be @c NULL.
+ * @param in_item what to search for, must not be @c NULL.
*
- * @return @a in_item if found, NULL if not.
+ * @return @a in_item if found, @c NULL if not.
*/
EAPI Eina_Inlist *eina_inlist_find(Eina_Inlist *in_list,
Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
* done to confirm this, and giving nodes from different lists
* will lead to problems.
*
- * @param list existing list head or NULL to create a new list.
- * @param item list node to move to beginning (head), must not be NULL.
+ * @param list existing list head or @c NULL to create a new list.
+ * @param item list node to move to beginning (head), must not be @c NULL.
*
* @return the new list head. Use it and not @a list anymore.
*/
* done to confirm this, and giving nodes from different lists
* will lead to problems.
*
- * @param list existing list head or NULL to create a new list.
- * @param item list node to move to end (tail), must not be NULL.
+ * @param list existing list head or @c NULL to create a new list.
+ * @param item list node to move to end (tail), must not be @c NULL.
*
* @return the new list head. Use it and not @a list anymore.
*/
* @return The number of members in the list.
*
* This function returns how many members @p list contains. If the
- * list is @c NULL, 0 is returned.
+ * list is @c NULL, @c 0 is returned.
*
* @warning This is an order-N operation and so the time will depend
* on the number of elements on the list, so, it might become
*
* This function returns a newly allocated accessor associated to
* @p in_list. If @p in_list is @c NULL or the count member of @p in_list is
- * less or equal than 0, this function returns @c NULL. If the memory can
+ * less or equal than @c 0, this function returns @c NULL. If the memory can
* not be allocated, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY is
* set. Otherwise, a valid accessor is returned.
*/
* @brief Insert a new node into a sorted list.
*
* @param list The given linked list, @b must be sorted.
- * @param item list node to insert, must not be NULL.
+ * @param item list node to insert, must not be @c NULL.
* @param func The function called for the sort.
* @return A list pointer.
* @since 1.1.0
* @brief Insert a new node into a sorted list.
*
* @param list The given linked list, @b must be sorted.
- * @param item list node to insert, must not be NULL.
+ * @param item list node to insert, must not be @c NULL.
* @param func The function called for the sort.
* @param state The current array for initial dichotomic search
* @return A list pointer.
* This function iterates over the elements pointed by @p iterator,
* beginning from the current element. For Each element, the callback
* @p cb is called with the data @p fdata. If @p iterator is @c NULL,
- * the function returns immediately. Also, if @p cb returns @c
- * EINA_FALSE, the iteration stops at that point, if @p cb returns @c EINA_TRUE
+ * the function returns immediately. Also, if @p cb returns #EINA_FALSE,
+ * the iteration stops at that point, if @p cb returns #EINA_TRUE
* the iteration continues.
*/
EAPI void eina_iterator_foreach(Eina_Iterator *iterator,
* container is locked calling eina_iterator_foreach() on it will return
* immediately. If @p iterator is @c NULL or if a problem occurred, #EINA_FALSE
* is returned, otherwise #EINA_TRUE is returned. If the container isn't
- * lockable, it will return EINA_TRUE.
+ * lockable, it will return #EINA_TRUE.
*
* @warning None of the existing eina data structures are lockable.
*/
* If the container of the @p iterator permits it and was previously
* locked, it will be unlocked. If @p iterator is @c NULL or if a
* problem occurred, #EINA_FALSE is returned, otherwise #EINA_TRUE
- * is returned. If the container is not lockable, it will return
- * EINA_TRUE.
+ * is returned. If the container is not lockable, it will
+ * return #EINA_TRUE.
*
* @warning None of the existing eina data structures are lockable.
*/
*
* This function searches in @p list from beginning to end for the
* first member whose data pointer is @p data. If it is found, @p data
- * will be returned, otherwise NULL will be returned.
+ * will be returned, otherwise @c NULL will be returned.
*
* Example:
* @code
* @brief Free an entire list and all the nodes, ignoring the data contained.
* @param list The list to free
- * @return A NULL pointer
+ * @return A @c NULL pointer
*
* This function frees all the nodes of @p list. It does not free the
* data of the nodes. To free them, use #EINA_LIST_FREE.
* for all entry of both list.
*
* Both left and right do not exist anymore after the merge.
- * If @p func is NULL, it will return NULL.
+ * If @p func is @c NULL, it will return @c NULL.
*
* Example:
* @code
* @return The new left list
*
* This function splits @p list into two lists ( left and right ) after the node @p relative. @p Relative
- * will become the last node of the left list. If @p list or @p right are NULL list is returns.
- * If @p relative is NULL right is set to @p list and NULL is returns.
- * If @p relative is the last node of @p list list is returns and @p right is set to NULL.
+ * will become the last node of the left list. If @p list or @p right are @c NULL list is returns.
+ * If @p relative is NULL right is set to @p list and @c NULL is returns.
+ * If @p relative is the last node of @p list list is returns and @p right is set to @c NULL.
*
* list does not exist anymore after the split.
*
* was found (exact match), then it is 0. If returned node is smaller
* than requested data, it is less than 0 and if it's bigger it's
* greater than 0. It is the last value returned by func().
- * @return the nearest node, NULL if not found.
+ * @return the nearest node, @c NULL if not found.
*
* This function searches for a node containing @p data as it's data in @p list,
* if such a node exists it will be returned and @p result_cmp will be @p 0. If
* @param list The list to search for data, @b must be sorted.
* @param func A function pointer that can handle comparing the list data nodes.
* @param data reference value to search.
- * @return the node if func(node->data, data) == 0, NULL if not found.
+ * @return the node if func(node->data, data) == 0, @c NULL if not found.
*
* This can be used to check if some value is inside the list and get
* the container node in this case. It should be used when list is
* @param list The list to search for data, may be unsorted.
* @param func A function pointer that can handle comparing the list data nodes.
* @param data reference value to search.
- * @return the node if func(node->data, data) == 0, NULL if not found.
+ * @return the node if func(node->data, data) == 0, @c NULL if not found.
*
* This can be used to check if some value is inside the list and get
* the container node in this case.
* @param func A function pointer that can handle comparing the list data nodes.
* @param data reference value to search.
* @return the node value (@c node->data) if func(node->data, data) == 0,
- * NULL if not found.
+ * @c NULL if not found.
*
* This can be used to check if some value is inside the list and get
* the existing instance in this case.
* @return The number of members in the list.
*
* This function returns how many members @p list contains. If the
- * list is @c NULL, 0 is returned.
+ * list is @c NULL, @c 0 is returned.
*
* NB: This is an order-1 operation and takes the same time regardless
* of the length of the list.
*
* This function returns a newly allocated accessor associated to
* @p list. If @p list is @c NULL or the count member of @p list is
- * less or equal than 0, this function returns NULL. If the memory can
- * not be allocated, NULL is returned and #EINA_ERROR_OUT_OF_MEMORY is
+ * less or equal than 0, this function returns @c NULL. If the memory can
+ * not be allocated, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY is
* set. Otherwise, a valid accessor is returned.
*
* @warning @p list must be a pointer to the first element of the list.
* @brief Get level that triggers abort if abort-on-critical is set.
*
* @return critical level equal or smaller than value will trigger
- * program abortion if eina_log_abort_on_critical_get() returns
- * #EINA_TRUE.
+ * program abortion if eina_log_abort_on_critical_get()
+ * returns #EINA_TRUE.
*
* @see eina_log_abort_on_critical_level_set()
* @see eina_log_abort_on_critical_get()
* eina_matrixsparse_cell_idx_clear() and possible others.
* @param user_data given to @a free_func as first parameter.
*
- * @return newly allocated matrix or NULL if allocation failed and eina_error
+ * @return Newly allocated matrix or @c NULL if allocation failed and eina_error
* is set.
*/
EAPI Eina_Matrixsparse *eina_matrixsparse_new(unsigned long rows,
/**
* @brief Get the current size of Sparse Matrix.
*
- * The given parameters are guaranteed to be set if they're not NULL,
+ * The given parameters are guaranteed to be set if they're not @c NULL,
* even if this function fails (ie: @a m is not a valid matrix instance).
*
* @param m the sparse matrix to operate on.
- * @param rows returns the number of rows, may be NULL. If @a m is invalid,
+ * @param rows returns the number of rows, may be @c NULL. If @a m is invalid,
* returned value is zero, otherwise it's a positive integer.
- * @param cols returns the number of columns, may be NULL. If @a m is
+ * @param cols returns the number of columns, may be @c NULL. If @a m is
* invalid, returned value is zero, otherwise it's a positive integer.
*/
EAPI void eina_matrixsparse_size_get(const Eina_Matrixsparse *m,
* @param m the sparse matrix to operate on.
* @param rows the new number of rows, must be greater than zero.
* @param cols the new number of columns, must be greater than zero.
- * @return 1 on success, 0 on failure.
+ * @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning cells, rows or columns are not reference counted and thus
* after this call any reference might be invalid if instance were
* @param col the new number of column to clear.
* @param cell pointer to return cell reference, if any exists.
*
- * @return 1 on success, 0 on failure. It is considered success if did not
+ * @return @c 1 on success, @c 0 on failure. It is considered success if did not
* exist but index is inside matrix size, in this case @c *cell == NULL
*
* @see eina_matrixsparse_cell_data_get()
* @param row the new number of row to clear.
* @param col the new number of column to clear.
*
- * @return data associated with given cell or NULL if nothing is associated.
+ * @return Data associated with given cell or @c NULL if nothing is associated.
*
* @see eina_matrixsparse_cell_idx_get()
* @see eina_matrixsparse_cell_data_get()
* @param row where to store cell row number, may be @c NULL.
* @param col where to store cell column number, may be @c NULL.
*
- * @return 1 on success, 0 otherwise (@c cell is @c NULL).
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@c cell is @c NULL).
*/
EAPI Eina_Bool eina_matrixsparse_cell_position_get(const Eina_Matrixsparse_Cell *cell, unsigned long *row, unsigned long *col);
* @param data new data to set.
* @param p_old returns the old value intact (not freed).
*
- * @return 1 on success, 0 otherwise (@a cell is @c NULL).
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@a cell is @c NULL).
*
* @see eina_matrixsparse_cell_data_set()
* @see eina_matrixsparse_data_idx_replace()
* @param cell the cell reference, must @b not be @c NULL.
* @param data new data to set.
*
- * @return 1 on success, 0 otherwise (@a cell is @c NULL).
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@a cell is @c NULL).
*
* @see eina_matrixsparse_cell_data_replace()
* @see eina_matrixsparse_data_idx_set()
* @param data new data to set.
* @param p_old returns the old value intact (not freed).
*
- * @return 1 on success, 0 otherwise (@a m is @c NULL, indexes are not valid).
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@a m is @c NULL, indexes are not valid).
*
* @see eina_matrixsparse_cell_data_replace()
* @see eina_matrixsparse_data_idx_set()
* @param col the column number to set the value.
* @param data new data to set.
*
- * @return 1 on success, 0 otherwise (@a m is @c NULL, indexes are not valid).
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@a m is @c NULL, indexes are not valid).
*
* @see eina_matrixsparse_cell_data_replace()
*/
* @param m the sparse matrix to operate on.
* @param row the new number of row to clear.
*
- * @return 1 on success, 0 on failure. It is considered success if row
+ * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered success if row
* had no cells filled. Failure is asking for clear row outside
* matrix size.
*
* @param m the sparse matrix to operate on.
* @param col the new number of column to clear.
*
- * @return 1 on success, 0 on failure. It is considered success if column
+ * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered success if column
* had no cells filled. Failure is asking for clear column outside
* matrix size.
*
* @param row the new number of row to clear.
* @param col the new number of column to clear.
*
- * @return 1 on success, 0 on failure. It is considered success if did not
+ * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered success if did not
* exist but index is inside matrix size.
*
* @warning cells, rows or columns are not reference counted and thus
*
* @param cell the cell reference, must @b not be @c NULL.
*
- * @return 1 on success, 0 on failure.
+ * @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning cells, rows or columns are not reference counted and thus
* after this call any reference might be invalid if instance were
/**
* @brief Enable or disable safe mmaped IO handling
*
- * @param enabled The enabled state (to enable, pass EINA_TRUE)
+ * @param enabled The enabled state (to enable, pass #EINA_TRUE)
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This enables (if possible on your platform) a signal handler for
/**
* @brief Get the enabled state of mmap safety.
*
- * @return The safety state (EINA_TRUE if enabled)
+ * @return The safety state (#EINA_TRUE if enabled)
*
* This returns the mmap safety state set by eina_mmap_safety_enabled_set().
* See eina_mmap_safety_enabled_set() for more information.
/**
* @brief Creates a new model of type @a Type.
* @param type The type of the model to create.
- * @return If successfull pointer to model, NULL otherwise.
+ * @return If successfull pointer to model, @c NULL otherwise.
*
* @see _Eina_Model_Type
* @see eina_model_del()
* @brief Returns the interface named @a name of @a model.
* @param model The model instance.
* @param name Name of interface to get.
- * @return If successfull requested interface, NULL otherwise.
+ * @return If successfull requested interface, @c NULL otherwise.
*
* The name of every interface of @a model will be compared to @a name, the
* first one to match will be returned.
* @brief Increases the refcount of @a model.
* @param model The model to increase reference.
* @return The @a model with reference increased.
- * @return If successfull pointer to model, NULL otherwise.
+ * @return If successfull pointer to model, @c NULL otherwise.
*
* @see eina_model_new()
* @see eina_model_unref()
/**
* @brief Decreases the refcount of @a model.
* @param model The model to decrease reference.
- * @return If successfull pointer to model, NULL otherwise.
+ * @return If successfull pointer to model, @c NULL otherwise.
*
* After this function returns, consider @a model pointer invalid.
*
* @brief Decreases the refcount of @a model, informs reference identifier.
* @param model The model to decrease reference.
* @param id An identifier to mark this reference.
- * @return If successfull pointer to model, NULL otherwise.
+ * @return If successfull pointer to model, @c NULL otherwise.
*
* This function will match eina_model_xref() and the @a id must match
* a previously call, otherwise it will produce an error if @c
* @param model The model instance.
* @param event_name The name of event for which @a cb will be called.
* @param cb The function to be called.
- * @param data Data @a cb will be called with. May be NULL.
+ * @param data Data @a cb will be called with. May be @c NULL.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @see eina_model_event_callback_del()
* @param model The model instance.
* @param event_name The name of event for which to delete callback.
* @param cb The function given to eina_model_event_callback_add().
- * @param data Data given to eina_model_event_callback_add(). A NULL value means
+ * @param data Data given to eina_model_event_callback_add(). A @c NULL value means
* every @a data will not be compared.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* event_info.
* @param model The model instance.
* @param name The event whose callbacks will be called.
- * @param event_info The data given to the callback as event_info. May be NULL.
+ * @param event_info The data given to the callback as event_info. May be @c NULL.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @see eina_model_event_callback_add()
* by user defined types can be given.
*
* @note The types provided by Eina_Model don't implement this method.
- * @note Calling this function on a model that doesn't implement it returns @c
- * EINA_TRUE without any effect on @a model.
+ * @note Calling this function on a model that doesn't implement it
+ * returns #EINA_TRUE without any effect on @a model.
*
* @see eina_model_unload()
* @since 1.2
* @brief Appends @a child in @a model.
* @param model The model instance.
* @param child The child to be appended.
- * @return The position of the added child, or -1 on failure.
+ * @return The position of the added child, or @c -1 on failure.
*
* @warning This increments the reference count of the child being inserted, if
* it will no longer be used by the inserting code it should call
* @param model The parent model whose children will be searched.
* @param start_position The first children to be compared with @a other.
* @param other The model whose position is desired.
- * @return The position of the searched for child, or -1 if not found.
+ * @return The position of the searched for child, or @c -1 if not found.
*
* @since 1.2
*/
* @param start_position The position of the first child to be checked.
* @param match The function used to check if a child matches the criteria.
* @param data Data given the to the @a match function.
- * @return The position of the first child to match the criteria or -1 if no
+ * @return The position of the first child to match the criteria or @c -1 if no
* child matches it.
*
* Returns the position of the first(from @a start_position) child of @a model
- * to which @a match returns EINA_TRUE.
+ * to which @a match returns #EINA_TRUE.
*
* @since 1.2
*/
* @param data Data passed to the @a match function.
* @return Newly created iterator instance on success or @c NULL on failure.
*
- * @note Only children for whom @a match returns EINA_TRUE will be included in
+ * @note Only children for whom @a match returns #EINA_TRUE will be included in
* the iterator.
*
* @note Each iteration(call to eina_iterator_next()) gives an integer index!
}
/**
* @def EINA_MODEL_TYPE_INIT_NULL
- * @brief NULL value eina model type.
+ * @brief @c NULL value eina model type.
*/
#define EINA_MODEL_TYPE_INIT_NULL \
{0, \
* @param type The type whose child get method will be called.
* @param model The model instance.
* @param position The position of the child to get.
- * @return The child model, or NULL on failure.
+ * @return The child model, or @c NULL on failure.
*
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If model doesn't inherit from (or is of) @a type does nothing and
- * returns EINA_FALSE.
+ * returns #EINA_FALSE.
*
* @see eina_model_child_set()
* @see _Eina_Model_Type
* @param model The model instance.
* @param start_position The first position to be checked.
* @param match The function used to determine if a child matches the criteria.
- * @param data Data given to the @a match function. May be NULL.
+ * @param data Data given to the @a match function. May be @c NULL.
* @return The position of the first child to match the criteria or -1 if no
* child matches it.
*
* @param start The first child to be a part of the iterator.
* @param count Number of children to be checked for inclusion in the iterator.
* @param match Function used to check if child will be included in the iterator.
- * @param data Data given to the @a match function. May be NULL.
+ * @param data Data given to the @a match function. May be @c NULL.
* @return Newly created iterator instance on success or @c NULL on failure.
*
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* @param compare Function used to compare children.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return -1.
+ * return @c -1.
*
* @see eina_model_child_sort().
* @since 1.2
* @brief Delete a module.
*
* @param module The module to delete.
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function calls eina_module_unload() if @p module has been previously
* loaded and frees the allocated memory. On success this function
- * returns EINA_TRUE and EINA_FALSE otherwise. If @p module is @c NULL, the
+ * returns #EINA_TRUE and #EINA_FALSE otherwise. If @p module is @c NULL, the
* function returns immediately.
*/
EAPI Eina_Bool
* @brief Load a module.
*
* @param module The module to load.
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function load the shared file object passed in
* eina_module_new(). If it is a internal Eina module (like the
* @brief Unload a module.
*
* @param module The module to load.
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function unload the module @p module that has been previously
* loaded by eina_module_load(). If the reference counter of @p module is
* @p path. If @p recursive is #EINA_TRUE, then recursive search is
* done. The callback @p cb is called on each module found, and @p data
* is passed to @p cb. If @p path is @c NULL, the function returns
- * immediately @p array. If the returned value of @p cb is 0, the
+ * immediately @p array. If the returned value of @p cb is @c 0, the
* module will not be added to the list, otherwise it will be added.
* @p array can be @c NULL. In that case, it is created with 4
* elements. @p cb can be @c NULL.
/**
* @brief Create a new prefix handle given some input information
*
- * @param argv0 If this is an executable this is argv[0] of the binary, or NULL if it is used from a shared library
- * @param symbol This is a symbol (function for example) inside the binary or library to find the source location of. Provide NULL if not used
+ * @param argv0 If this is an executable this is argv[0] of the binary, or @c NULL if it is used from a shared library
+ * @param symbol This is a symbol (function for example) inside the binary or library to find the source location of. Provide @c NULL if not used
* @param envprefix This is the prefix to any environment variables that may override prefix detection and give the exact location of the software
* @param sharedir This is the directory inside the standard share or data dir where the software will store data files
- * @param magicsharefile This is a magic file to check existence of to determine the prefix find was correct, and it must be located in the data dir under the share dir provided above, or NULL if the check is not to be done
+ * @param magicsharefile This is a magic file to check existence of to determine the prefix find was correct, and it must be located in the data
+ * dir under the share dir provided above, or @c NULL if the check is not to be done.
* @param pkg_bin This is the compile-time binary install dir
* @param pkg_lib This is the compile-time library install dir
* @param pkg_data This is the compile-time share/data install dir
* @param pkg_locale This is the compile-time locale install dir
- * @return The prefix handle, or NULL on failure
+ * @return The prefix handle, or @c NULL on failure.
*
* Applications and libraries are most often not just single executables nor
* single shared library binaries, but also come with extra modules they
* to look in absolute directories, relative paths and PATH to see if it
* finds the right executable to determine just where the actual binary is
* installed and being run from. If you develop a share library, just pass
- * NULL as argv0
+ * @c NULL as argv0
*
* It would prefer to use the @p symbol function to determine location as
* that function will be unique inside the application and try and trace
* @param data Private data to help the compare function.
* @return The new root of the red black tree.
*
- * This function insert a new node in a valid red black tree. NULL is
+ * This function insert a new node in a valid red black tree. @c NULL is
* an empty valid red black tree. The resulting new tree is a valid red
* black tree. This function doesn't allocate any data.
*/
* @return The new root of the red black tree.
*
* This function remove a new node in a valid red black tree that should
- * contain the node that you are removing. This function will return NULL
+ * contain the node that you are removing. This function will return @c NULL
* when the red black tree got empty. This function doesn't free any data.
*/
EAPI Eina_Rbtree *eina_rbtree_inline_remove(Eina_Rbtree *root, Eina_Rbtree *node, Eina_Rbtree_Cmp_Node_Cb cmp, const void *data) EINA_ARG_NONNULL(2, 3) EINA_WARN_UNUSED_RESULT;
* 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
- * function return EINA_FALSE the parser will abort. @param
+ * function return #EINA_FALSE the parser will abort. @param
* data what to give as context to @a func.
*
- * @return EINA_TRUE on success or EINA_FALSE if it was aborted by user or
+ * @return #EINA_TRUE on success or #EINA_FALSE if it was aborted by user or
* parsing error.
*/
EAPI Eina_Bool eina_simple_xml_parse(const char *buf, unsigned buflen,
* @param buf the input string. May not contain \0 terminator.
* @param buflen the input string size.
* @return pointer to the start of attributes, it can be used
- * to feed eina_simple_xml_attributes_parse(). NULL is returned
+ * to feed eina_simple_xml_attributes_parse(). @c NULL is returned
* if no attributes were found.
*
* The tag contents is returned by eina_simple_xml_parse() when
* reference is just valid until the function return.
* @param data data to pass to the callback function.
*
- * @return EINA_TRUE on success or EINA_FALSE if it was aborted by user or
+ * @return #EINA_TRUE on success or #EINA_FALSE if it was aborted by user or
* parsing error.
*/
EAPI Eina_Bool eina_simple_xml_attributes_parse(const char *buf, unsigned buflen,
*
* @param parent if provided, will be set in the resulting structure
* as well as the attribute will be appended to attributes list.
- * @param key null-terminated string. Must not be NULL.
- * @param value null-terminated string. If NULL, the empty string will be used.
+ * @param key Null-terminated string. Must not be @c NULL.
+ * @param value Null-terminated string. If @c NULL, the empty string will be used.
*
- * @return newly allocated memory or NULL on error. This memory should be
+ * @return Newly allocated memory or @c NULL on error. This memory should be
* released with eina_simple_xml_attribute_free() or indirectly
* with eina_simple_xml_node_tag_free().
*/
*
* @param parent if provided, will be set in the resulting structure
* as well as the tag will be appended to children list.
- * @param name null-terminated string. Must not be NULL.
+ * @param name Null-terminated string. Must not be @c NULL.
*
- * @return newly allocated memory or NULL on error. This memory should be
+ * @return Newly allocated memory or @c NULL on error. This memory should be
* released with eina_simple_xml_node_tag_free() or indirectly
* with eina_simple_xml_node_tag_free() of the parent.
*/
*
* @param parent if provided, will be set in the resulting structure
* as well as the data will be appended to children list.
- * @param contents string to be used. Must not be NULL.
+ * @param contents String to be used. Must not be @c NULL.
* @param length size in bytes of @a contents.
*
- * @return newly allocated memory or NULL on error. This memory should be
+ * @return Newly allocated memory or NULL on error. This memory should be
* released with eina_simple_xml_node_data_free() or indirectly
* with eina_simple_xml_node_tag_free() of the parent.
*/
*
* @param parent if provided, will be set in the resulting structure
* as well as the cdata will be appended to children list.
- * @param contents string to be used. Must not be NULL.
+ * @param contents String to be used. Must not be @c NULL.
* @param length size in bytes of @a content.
*
- * @return newly allocated memory or NULL on error. This memory should be
+ * @return Newly allocated memory or @c NULL on error. This memory should be
* released with eina_simple_xml_node_cdata_free() or indirectly
* with eina_simple_xml_node_tag_free() of the parent.
*/
*
* @param parent if provided, will be set in the resulting structure
* as well as the processing will be appended to children list.
- * @param contents string to be used. Must not be NULL.
+ * @param contents String to be used. Must not be @c NULL.
* @param length size in bytes of @a contents.
*
- * @return newly allocated memory or NULL on error. This memory should be
+ * @return Newly allocated memory or @c NULL on error. This memory should be
* released with eina_simple_xml_node_processing_free() or indirectly
* with eina_simple_xml_node_tag_free() of the parent.
*/
*
* @param parent if provided, will be set in the resulting structure
* as well as the doctype will be appended to children list.
- * @param contents string to be used. Must not be NULL.
+ * @param contents String to be used. Must not be @c NULL.
* @param length size in bytes of @a contents.
*
- * @return newly allocated memory or NULL on error. This memory should be
+ * @return Newly allocated memory or @c NULL on error. This memory should be
* released with eina_simple_xml_node_doctype_free() or indirectly
* with eina_simple_xml_node_tag_free() of the parent.
*/
*
* @param parent if provided, will be set in the resulting structure
* as well as the comment will be appended to children list.
- * @param contents string to be used. Must not be NULL.
+ * @param contents String to be used. Must not be @c NULL.
* @param length size in bytes of @a contents.
*
- * @return newly allocated memory or NULL on error. This memory should be
+ * @return Newly allocated memory or @c NULL on error. This memory should be
* released with eina_simple_xml_node_comment_free() or indirectly
* with eina_simple_xml_node_tag_free() of the parent.
*/
* @param strip whenever this parser should strip leading and trailing
* whitespace.
*
- * @return document root with children tags, or NULL on errors.
- * Document with errors may return partial tree instead of NULL,
+ * @return Document root with children tags, or @c NULL on errors.
+ * Document with errors may return partial tree instead of @c NULL,
* we'll do our best to avoid returning nothing.
*/
EAPI Eina_Simple_XML_Node_Root * eina_simple_xml_node_load(const char *buf, unsigned buflen, Eina_Bool strip);
* Converts the node tree under the given element to a XML string.
*
* @param node the base node to convert.
- * @param indent indentation string, or NULL to disable it.
+ * @param indent Indentation string, or @c NULL to disable it.
*
- * @return NULL on errors or a newly allocated string on success.
+ * @return @c NULL on errors or a newly allocated string on success.
*/
EAPI char * eina_simple_xml_node_dump(Eina_Simple_XML_Node *node, const char *indent);
* @return The length of the source string.
*
* This function copies up to @p siz - 1 characters from the
- * NUL-terminated string @p src to @p dst, NUL-terminating the result
+ * NULL-terminated string @p src to @p dst, NULL-terminating the result
* (unless @p siz is equal to 0). The returned value is the length of
* @p src. If the returned value is greater than @p siz, truncation
* occurred.
*
* @note The main difference between eina_strlcpy and strncpy is that this
- * ensures @p dst is NULL terminated even if no NULL byte is found in the first
+ * ensures @p dst is NULL-terminated even if no @c NULL byte is found in the first
* @p siz bytes of src.
*/
EAPI size_t eina_strlcpy(char *dst, const char *src, size_t siz) EINA_ARG_NONNULL(1, 2);
*
* This function appends @p src to @p dst of size @p siz (unlike
* strncat, @p siz is the full size of @p dst, not space left). At
- * most @p siz - 1 characters will be copied. Always NUL terminates
+ * most @p siz - 1 characters will be copied. Always NULL-terminates
* (unless @p siz <= strlen(dst)). This function returns strlen(src) +
* MIN(siz, strlen(initial dst)). If the returned value is greater or
* equal than @p siz, truncation occurred.
* @param string The string to split.
* @param delimiter The string which specifies the places at which to split the string.
* @param max_tokens The maximum number of strings to split string into.
- * @return A newly-allocated NULL-terminated array of strings or NULL if it
+ * @return A newly-allocated NULL-terminated array of strings or @c NULL if it
* fails to allocate the array.
*
* This functin splits @p string into a maximum of @p max_tokens pieces,
* @p max_tokens is less than @c 1, the string is splitted completely. 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 NULL if it fails to
+ * newly allocated NULL-terminated array of strings or @c NULL if it fails to
* allocate the array. To free it, free the first element of the array and the
* array itself.
*
* @param max_tokens The maximum number of strings to split string into.
* @param elements Where to return the number of elements in returned
* array (not counting the terminating @c NULL). May be @c NULL.
- * @return A newly-allocated NULL-terminated array of strings or NULL if it
+ * @return A newly-allocated NULL-terminated array of strings or @c NULL if it
* fails to allocate the array.
*
* This function splits @p string into a maximum of @p max_tokens pieces,
* @p max_tokens is less than @c 1, the string is splitted completely. 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 NULL if it fails to
+ * newly allocated NULL-terminated array of strings or @c NULL if it fails to
* allocate the array. To free it, free the first element of the array and the
* array itself.
*
* @param fmt The string to prepend.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * This macro is calling eina_strbuf_insert_printf() at position 0.If @p buf
+ * This macro is calling eina_strbuf_insert_printf() at position 0. If @p buf
* can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
* returned.
*/
*
* This function replaces all the occurrences of @p str in @p buf with
* the string @p with. This function returns the number of times @p str
- * has been replaced. On failure, it returns 0.
+ * has been replaced. On failure, it returns @c 0.
*/
EAPI int eina_strbuf_replace_all(Eina_Strbuf *buf, const char *str, const char *with) EINA_ARG_NONNULL(1, 2, 3);
/**
* @brief Retrieve an instance of a string for use in a program.
*
- * @param str The NULL terminated string to retrieve an instance of.
+ * @param str The NULL-terminated string to retrieve an instance of.
* @return A pointer to an instance of the string on success.
* @c NULL on failure.
*
* @brief Retrieve an instance of a string for use in a program
* from a format string.
*
- * @param fmt The NULL terminated format string to retrieve an instance of.
+ * @param fmt The NULL-terminated format string to retrieve an instance of.
* @return A pointer to an instance of the string on success.
* @c NULL on failure.
*
* is just returned and its reference counter is increased. Otherwise
* a duplicated string is returned.
*
- * The format string @p fmt must be NULL terminated ('@\0') and its full
+ * The format string @p fmt must be NULL-terminated ('@\0') and its full
* length will be used. To use part of the format string or non-null
* terminated, use eina_stringshare_nprintf() instead.
*
* @brief Retrieve an instance of a string for use in a program
* from a format string.
*
- * @param fmt The NULL terminated format string to retrieve an instance of.
+ * @param fmt The NULL-terminated format string to retrieve an instance of.
* @param args The va_args for @p fmt
* @return A pointer to an instance of the string on success.
* @c NULL on failure.
* is just returned and its reference counter is increased. Otherwise
* a duplicated string is returned.
*
- * The format string @p fmt must be NULL terminated ('@\0') and its full
+ * The format string @p fmt must be NULL-terminated ('@\0') and its full
* length will be used. To use part of the format string or non-null
* terminated, use eina_stringshare_nprintf() instead.
*
*
* This function decreases the reference counter associated to @p str
* if it exists. If that counter reaches 0, the memory associated to
- * @p str is freed. If @p str is NULL, the function returns
+ * @p str is freed. If @p str is @c NULL, the function returns
* immediately.
*
* Note that if the given pointer is not shared or NULL, bad things
* @brief Note that the given string @b must be shared.
*
* @param str the shared string to know the length. It is safe to
- * give NULL, in that case -1 is returned.
+ * give @c NULL, in that case @c -1 is returned.
* @return The length of a shared string.
*
* This function is a cheap way to known the length of a shared
*
* @note This is a convenience function, iterating over the returned iterator is
* equivalent to calling eina_tile_grid_slicer_setup() and calling
- * eina_tile_grid_slicer_next() untill it returns EINA_FALSE.
+ * eina_tile_grid_slicer_next() untill it returns #EINA_FALSE.
*/
EAPI Eina_Iterator *eina_tile_grid_slicer_iterator_new(int x, int y, int w, int h, int tile_w, int tile_h);
/**
*
* @param slc Pointer to an Eina_Tile_Grid_Slicer struct.
* @param rect Pointer to a struct Eina_Tile_Grid_Info *.
- * @return @c EINA_TRUE if the current rect is valid.
- * @c EINA_FALSE if there is no more rects to iterate over (and
- * thus the current one isn't valid).
+ * @return #EINA_TRUE if the current rect is valid. #EINA_FALSE if there
+ * is no more rects to iterate over (and thus the current one isn't valid).
*
* This functions iterates over each Eina_Tile_Grid_Info *rect of the grid.
* eina_tile_grid_slicer_setup() must be called first, and *rect is only valid
- * if this function returns EINA_TRUE. Its content shouldn't be modified.
+ * if this function returns #EINA_TRUE. Its content shouldn't be modified.
*
* @note Consider using eina_tile_grid_slicer_iterator_new() instead.
*/
* Reads UTF8 bytes from @p buf, starting at @p iindex and returns
* the decoded code point at @p iindex offset, and advances @p iindex
* to the next code point after this. @p iindex is always advanced,
- * unless if the advancement is after the NULL.
+ * unless if the advancement is after the @c NULL.
* On error: return a codepoint between DC80 to DCFF where the low 8 bits
* are the byte's value.
*
/**
* @brief Retrieve an instance of a string for use in a program.
*
- * @param str The NULL terminated string to retrieve an instance of.
+ * @param str The NULL-terminated string to retrieve an instance of.
* @return A pointer to an instance of the string on success.
* @c NULL on failure.
*
* it is added to the strings to be searched and a duplicated string
* of @p str is returned.
*
- * The string @p str must be NULL terminated ('@\0') and its full
+ * The string @p str must be NULL-terminated ('@\0') and its full
* length will be used. To use part of the string or non-null
* terminated, use eina_stringshare_add_length() instead.
*
*
* This function decreases the reference counter associated to @p str
* if it exists. If that counter reaches 0, the memory associated to
- * @p str is freed. If @p str is NULL, the function returns
+ * @p str is freed. If @p str is @c NULL, the function returns
* immediately.
*
- * Note that if the given pointer is not shared or NULL, bad things
+ * Note that if the given pointer is not shared or @c NULL, bad things
* will happen, likely a segmentation fault.
*/
EAPI void eina_ustringshare_del(const Eina_Unicode *str);
* @brief Note that the given string @b must be shared.
*
* @param str the shared string to know the length. It is safe to
- * give NULL, in that case -1 is returned.
+ * give @c NULL, in that case @c -1 is returned.
*
* This function is a cheap way to known the length of a shared
* string. Note that if the given pointer is not shared, bad
* @param size The size of the retrieved extended attribute.
* @return the allocated data that hold the extended attribute value.
*
- * It will return NULL and *size will be @c 0 if it fails.
+ * It will return @c NULL and *size will be @c 0 if it fails.
*
* @since 1.1
*/
* @param data The data to set.
* @param length The length of the data to set.
* @param flags Define the set policy.
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* @since 1.1
*/
*
* @param file The file to set the string to.
* @param attribute The attribute to set.
- * @param data The NULL terminated string to set.
+ * @param data The NULL-terminated string to set.
* @param flags Define the set policy.
* @return EINA_TRUE on success, EINA_FALSE otherwise.
*
*
* @param file The file to get the string from.
* @param attribute The attribute to get.
- * @return a valid string on success, NULL otherwise.
+ * @return A valid string on success, @c NULL otherwise.
*
* This call check that the string is properly NULL-terminated before returning it.
*
*
* @param file The file to set the double to.
* @param attribute The attribute to set.
- * @param value The NULL terminated double to set.
+ * @param value The NULL-terminated double to set.
* @param flags Define the set policy.
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* @since 1.1
*/
* @param file The file to get the string from.
* @param attribute The attribute to get.
* @param value Where to put the extracted value
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This call check that the double is correctly set.
*
*
* @param file The file to set the int to.
* @param attribute The attribute to set.
- * @param value The NULL terminated int to set.
+ * @param value The NULL-terminated int to set.
* @param flags Define the set policy.
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* @since 1.1
*/
* @param file The file to get the string from.
* @param attribute The attribute to get.
* @param value Where to put the extracted value
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This call check that the int is correctly set.
*
projects / profile / ivi / eina.git / commitdiff