*
* This function retrieves the data of the element pointed by
* @p accessor at the porition @p position, and stores it in
- * @p data. If @p accessor is @c NULL or if an error occurred,
- * #EINA_FALSE is returned, otherwise EINA_TRUE is returned.
+ * @p data. If @p accessor is @c NULL or if an error occurred, #EINA_FALSE
+ * is returned, otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool eina_accessor_data_get(Eina_Accessor *accessor,
unsigned int position,
* another element will increase the buffer by @p step elements again.
*
* This function return a valid array on success, or @c NULL if memory
- * allocation fails. In that case, the error is set to
- * #EINA_ERROR_OUT_OF_MEMORY.
+ * allocation fails. In that case, the error is set
+ * to #EINA_ERROR_OUT_OF_MEMORY.
*/
EAPI Eina_Array *eina_array_new(unsigned int step) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_WARN_UNUSED_RESULT;
*
* This function frees @p array. It calls first eina_array_flush() then
* free the memory of the pointer. It does not free the memory
- * allocated for the elements of @p array. To free them, use
- * #EINA_ARRAY_ITER_NEXT. For performance reasons, there is no check
+ * allocated for the elements of @p array. To free them,
+ * use #EINA_ARRAY_ITER_NEXT. For performance reasons, there is no check
* of @p array.
*/
EAPI void eina_array_free(Eina_Array *array) EINA_ARG_NONNULL(1);
* to name the gnuplot file that eina_benchmark_run() will create.
*
* This function return a valid benchmark on success, or @c NULL if
- * memory allocation fails. In that case, the error is set to
- * #EINA_ERROR_OUT_OF_MEMORY.
+ * memory allocation fails. In that case, the error is set
+ * to #EINA_ERROR_OUT_OF_MEMORY.
*
* When the new module is not needed anymore, use
* eina_benchmark_free() to free the allocated memory.
* @param c The char to append.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * This function inserts @p c to @p buf. If it can not insert it,
- * #EINA_FALSE is returned, otherwise #EINA_TRUE is returned.
+ * This function inserts @p c to @p buf. If it can not insert it, #EINA_FALSE
+ * is returned, otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool eina_binbuf_append_char(Eina_Binbuf *buf, unsigned char c) EINA_ARG_NONNULL(1);
* @return The new hash table.
*
* This function creates a new hash table using user-defined callbacks
- * to manage the hash table. On failure, @c NULL is returned and
- * #EINA_ERROR_OUT_OF_MEMORY is set. If @p key_cmp_cb or @p key_hash_cb
+ * to manage the hash table. On failure, @c NULL is returned
+ * and #EINA_ERROR_OUT_OF_MEMORY is set. If @p key_cmp_cb or @p key_hash_cb
* are @c NULL, @c NULL is returned. If @p buckets_power_size is
* smaller or equal than 2, or if it is greater or equal than 17,
* @c NULL is returned.
* This function removes the entry identified by @p key or @p data
* from @p hash. If a free function was given to the
* callback on creation, it will be called for the data being
- * deleted. If @p hash is @c NULL, the functions returns immediately
- * #EINA_FALSE. If @p key is @c NULL, then @p data is used to find the a
+ * deleted. If @p hash is @c NULL, the functions returns immediately #EINA_FALSE.
+ * If @p key is @c NULL, then @p data is used to find the a
* match to remove, otherwise @p key is used and @p data is not
* required and can be @c NULL. This function returns #EINA_FALSE if
* an error occurred, #EINA_TRUE otherwise.
* callback on creation, it will be called for the data being
* deleted. Do not forget to count '\\0' for string when setting the
* value of @p key_length. If @p hash or @p key are @c NULL, the
- * functions returns immediately #EINA_FALSE. This function returns
- * #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
+ * functions returns immediately #EINA_FALSE. This function
+ * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
*
* @note if you don't have the key_hash, use eina_hash_del_by_key() instead.
* @note if you don't have the key, use eina_hash_del_by_data() instead.
* using functiond provided to has creation function. If a free
* function was given to the callback on creation, it will be called
* for the data being deleted. If @p hash or @p key are @c NULL, the
- * functions returns immediately #EINA_FALSE. This function returns
- * #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
+ * functions returns immediately #EINA_FALSE. This function
+ * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
*
* @note if you already have the key_hash, use eina_hash_del_by_key_hash()
* instead.
* This function removes the entry identified by @p key and
* @p key_hash, or @p data, from @p hash. If a free function was given to
* the callback on creation, it will be called for the data being
- * deleted. If @p hash is @c NULL, the functions returns immediately
- * #EINA_FALSE. If @p key is @c NULL, then @p key_length and @p key_hash
+ * deleted. If @p hash is @c NULL, the functions returns immediately #EINA_FALSE.
+ * If @p key is @c NULL, then @p key_length and @p key_hash
* are ignored and @p data is used to find a match to remove,
* otherwise @p key and @p key_hash are used and @p data is not
* required and can be @c NULL. Do not forget to count '\\0' for
* 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 and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
+ * If the memory can not be allocated, NULL is returned
+ * and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @warning if the hash structure changes then the iterator becomes
* valid iterator that will always return false on
* eina_iterator_next(), thus keeping API sane.
*
- * If the memory can not be allocated, @c NULL is returned and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
+ * 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.
*
* @warning if the hash structure changes then the iterator becomes
* 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 and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
+ * If the memory can not be allocated, NULL is returned
+ * and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @note iterator data will provide values as Eina_Hash_Tuple that should not
*
* Call @a function for every given data in @a array.
*
- * Safe way to iterate over an array. @p function 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.
+ * Safe way to iterate over an array. @p function 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.
*
* The data given to @a function are the pointer to member memory
* itself.
* This function returns a newly allocated iterator associated to
* @p array.
*
- * If the memory can not be allocated, NULL is returned and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
+ * If the memory can not be allocated, NULL is returned
+ * and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @warning if the array structure changes then the iterator becomes
*
* Unlike eina_inarray_iterator_new(), this will walk the array backwards.
*
- * If the memory can not be allocated, NULL is returned and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
+ * If the memory can not be allocated, NULL is returned
+ * and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @warning if the array structure changes then the iterator becomes
* This function returns a newly allocated accessor associated to
* @p array.
*
- * If the memory can not be allocated, NULL is returned and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid accessor is
+ * If the memory can not be allocated, NULL is returned
+ * and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid accessor is
* returned.
*
* @since 1.2
* This function appends @p data to @p array. For performance
* reasons, there is no check of @p array. If it is @c NULL or
* invalid, the program may crash. If @p data is @c NULL, or if an
- * allocation is necessary and fails, #EINA_FALSE is returned and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, #EINA_TRUE is
+ * allocation is necessary and fails, #EINA_FALSE is returned
+ * and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, #EINA_TRUE is
* returned.
*/
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function creates a new #Eina_Lock object and stores it in the
- * @p mutex buffer. On success, this function returns #EINA_TRUE and
- * #EINA_FALSE otherwise. To free the resources allocated by this
+ * @p mutex buffer. On success, this function returns #EINA_TRUE
+ * and #EINA_FALSE otherwise. To free the resources allocated by this
* function, use eina_lock_free(). For performance reasons, no check
* is done on @p mutex.
*/
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function locks @p mutex. @p mutex must have been created by
- * eina_lock_new(). On success, this function returns #EINA_TRUE and
- * #EINA_FALSE otherwise. For performance reasons, no check is done on
+ * eina_lock_new(). On success, this function returns #EINA_TRUE
+ * and #EINA_FALSE otherwise. For performance reasons, no check is done on
* @p mutex.
*/
static inline Eina_Lock_Result
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function tries to lock @p mutex. @p mutex must have been created by
- * eina_lock_new(). If @p mutex can be locked, this function returns
- * #EINA_TRUE; if @p mutex can not be locked, or is already locked, it
+ * eina_lock_new(). If @p mutex can be locked, this function returns #EINA_TRUE;
+ * if @p mutex can not be locked, or is already locked, it
* returns #EINA_FALSE. This function does not block and returns
* immediately. For performance reasons, no check is done on
* @p mutex.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function unlocks @p mutex. @p mutex must have been created by
- * eina_lock_new(). On success, this function returns #EINA_TRUE and
- * #EINA_FALSE otherwise. For performance reasons, no check is done on
- * @p mutex.
+ * eina_lock_new(). On success, this function returns #EINA_TRUE
+ * and #EINA_FALSE otherwise. For performance reasons, no check is
+ * done on @p mutex.
*/
static inline Eina_Lock_Result
eina_lock_release(Eina_Lock *mutex EINA_UNUSED)
* @param l2 The length of the second span.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
- * This function returns #EINA_TRUE if the given spans intersect,
- * #EINA_FALSE otherwise.
+ * This function returns #EINA_TRUE if the given spans intersect, #EINA_FALSE
+ * otherwise.
*/
static inline int
eina_spans_intersect(int c1, int l1, int c2, int l2)
* @param r2 The second rectangle.
* @return #EINA_TRUE if the rectangles intersect, #EINA_FALSE otherwise.
*
- * This function returns #EINA_TRUE if @p r1 and @p r2 intersect,
- * #EINA_FALSE otherwise. No check is done on @p r1 and @p r2, so they
- * must be valid rectangles.
+ * This function returns #EINA_TRUE if @p r1 and @p r2 intersect, #EINA_FALSE
+ * otherwise. No check is done on @p r1 and @p r2, so they must be valid
+ * rectangles.
*/
static inline Eina_Bool
eina_rectangles_intersect(const Eina_Rectangle *r1, const Eina_Rectangle *r2)
* will always return false on eina_iterator_next(), thus keeping API
* sane.
*
- * If the memory can not be allocated, NULL is returned and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator 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.
*
* @warning if the list structure changes then the iterator becomes
* invalid, and if you add or remove nodes iterator
* will always return false on eina_iterator_next(), thus keeping API
* sane.
*
- * If the memory can not be allocated, NULL is returned and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
- * returned.
+ * If the memory can not be allocated, NULL is returned
+ * and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator
+ * is returned.
*
* @warning @p list must be a pointer to the first element of the list.
*
*
* Unlike eina_list_iterator_new(), this will walk the list backwards.
*
- * If the memory can not be allocated, NULL is returned and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
- * returned.
+ * If the memory can not be allocated, NULL is returned
+ * and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator
+ * is returned.
*
* @warning @p list must be a pointer to the first element of the list.
*
/**
* @def EINA_MAGIC_SET(d, m)
* Set the magic number of @p d to @p m. @p d must be a valid pointer
- * to a structure holding an Eina magic number declaration. Use
- * #EINA_MAGIC to add such declaration.
+ * to a structure holding an Eina magic number declaration.
+ * Use #EINA_MAGIC to add such declaration.
*
* If the magic feature of Eina is disabled, #EINA_MAGIC_CHECK is just
* the value @c 0.
* Not as generic as #EINA_MODEL_TYPE_GENERIC, but way more efficient
* is #EINA_MODEL_TYPE_STRUCT that instead of a hash of properties of
* any type, it uses a struct to map properties. Its properties are
- * fixed set of names and they have fixed type, as defined by the
- * #Eina_Value_Struct_Desc description used internally.
+ * fixed set of names and they have fixed type, as defined by
+ * the #Eina_Value_Struct_Desc description used internally.
*
* Examples:
* @li @ref eina_model_01_c inheritance example, uses #EINA_MODEL_TYPE_GENERIC
* example that demonstrates several of the important features of
* eina_model, uses #EINA_MODEL_TYPE_GENERIC.
* @li @ref eina_model_03_example_page walk-through example on how to
- * inherit types, a suggestion of eina_model_load() usage and uses
- * #EINA_MODEL_TYPE_STRUCT.
+ * inherit types, a suggestion of eina_model_load() usage and
+ * uses #EINA_MODEL_TYPE_STRUCT.
* @li @ref eina_model_04_c Advanced inheritance, interfaces and interface
* function overloading example.
*
* @defgroup Eina_Model_Event_Group Data Model Events
* Events and their usage with models.
*
- * Events are specified by each type and interface level using
- * #Eina_Model_Event_Description. One can know all events supported by
- * a model with eina_model_event_names_list_get() and then
+ * Events are specified by each type and interface level
+ * using #Eina_Model_Event_Description. One can know all events supported
+ * by a model with eina_model_event_names_list_get() and then
* eina_model_event_description_get() to retrieve details.
*
* By default the following events are supported in every object:
* 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_load()
* @since 1.2
* @param[in] model The model from which to get the property.
* @param[in] name The name of the property whose value is wanted.
* @param[out] value A pointer to an Eina_Value to receive the property's value.
- * @return #EINA_TRUE on success, #EINA_FALSE on failure.
- *
- * @return EINA_TRUE if @a model has a property named @a name, EINA_FALSE
+ * @return #EINA_TRUE if @a model has a property named @a name, #EINA_FALSE
* otherwise.
*
* @see eina_model_property_set()
* order. Whenever they do not exist, their parent pointer is
* called.
* @note a runtime check will enforce just types with ABI version
- * #EINA_MODEL_TYPE_VERSION are used by comparing with the @c version
- * member.
+ * version #EINA_MODEL_TYPE_VERSION are used by comparing with
+ * the @c version member.
*
* @since 1.2
*/
* @note You should only do your type's initialization after the parent type has
* done his own(this is as to ensure you can call on your parent's methods).
*
- * @warning If model doesn't inherit from(or is of) @a type does nothing and
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_new()
* @see _Eina_Model_Type
* @note It's considered good practice to free your type's resources before
* calling the parent's destructor.
*
- * @warning If model doesn't inherit from(or is of) @a type does nothing and
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_del()
* @see _Eina_Model_Type
* @param dst Pointer to where copy will be put.
* @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.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_copy()
* @see _Eina_Model_Type
* @param dst Pointer to where copy will be put.
* @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.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_deep_copy()
* @see _Eina_Model_Type
* -1 if @a b is smaller than @a a, 0 if @a a and @a b are equal.
* @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.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_compare()
* @see _Eina_Model_Type
* @param model The model instance.
* @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.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_load()
* @see _Eina_Model_Type
* @param model The model instance.
* @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.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_unload()
* @see _Eina_Model_Type
* @param[in] model The model instance.
* @param[in] name Name of property to get.
* @param[out] value Pointer to where value of property will be placed.
- * @return EINA_TRUE if able to get property, EINA_FALSE otherwise.
+ * @return #EINA_TRUE if able to get property, #EINA_FALSE otherwise.
*
- * @warning If model doesn't inherit from(or is of) @a type does nothing and
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_property_get()
* @see _Eina_Model_Type
* @param value The value to be set.
* @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.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_property_set()
* @see _Eina_Model_Type
* @param name The name of the property to be deleted.
* @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.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_property_del()
* @see _Eina_Model_Type
* @param model The model instance.
* @return #Eina_List of properties' names.
*
- * @warning If model doesn't inherit from(or is of) @a type does nothing and
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_properties_names_list_get()
* @see _Eina_Model_Type
* @param model The model instance.
* @return Number of children in @a model.
*
- * @warning If model doesn't inherit from(or is of) @a type does nothing and
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_child_count()
* @see _Eina_Model_Type
* @param position The position of the child to get.
* @return The child model, or NULL on failure.
*
- * @warning If model doesn't inherit from(or is of) @a type does nothing and
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_child_get()
* @see _Eina_Model_Type
* @param type The type whose child set method will be called.
* @param model The model instance.
* @param position The position of the child to be set.
- * @param child Pointer to value(child) to be set.
+ * @param child Pointer to value (child) to be set.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * @warning If model doesn't inherit from(or is of) @a type does nothing and
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns EINA_FALSE.
*
* @see eina_model_child_set()
* @param position Position of child to be deleted.
* @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.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_child_del()
* @see _Eina_Model_Type
* @param child The child to be inserted.
* @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.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_child_insert_at()
* @see _Eina_Model_Type
* @param other The child being searched for.
* @return The index of the searched child, or -1 if not found.
*
- * @warning If model doesn't inherit from(or is of) @a type does nothing and
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_child_find()
* @see _Eina_Model_Type
* @return The position of the first child to match the criteria or -1 if no
* child matches it.
*
- * @warning If model doesn't inherit from(or is of) @a type does nothing and
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_child_criteria_match()
* @see _Eina_Model_Type
* @param model The model instance.
* @param compare Function used to compare children.
*
- * @warning If model doesn't inherit from(or is of) @a type does nothing and
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_child_sort()
* @see _Eina_Model_Type
* @param count The number of children included in the iterator.
* @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
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_child_iterator_get()
* @see _Eina_Model_Type
* @param count The number of children included in the iterator.
* @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
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_child_reversed_iterator_get()
* @see _Eina_Model_Type
* @param compare Function used to compare children.
* @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
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_child_sorted_iterator_get()
* @see _Eina_Model_Type
* @param data Data given to the @a match function. May be 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
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_child_filtered_iterator_get()
* @see _Eina_Model_Type
* @param model The model instance.
* @return String representationof @a model.
*
- * @warning If model doesn't inherit from(or is of) @a type does nothing and
- * returns EINA_FALSE.
+ * @warning If model doesn't inherit from (or is of) @a type does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_to_string()
* @see _Eina_Model_Type
* type counterparts. Unlike setup and flush, they are not
* guaranteed to be called.
* @note use the same name pointer on queries to speed up the lookups!
- * @note a runtime check will enforce just types with ABI version
- * #EINA_MODEL_INTERFACE_VERSION are used by comparing with the
- * @c version member.
+ * @note a runtime check will enforce just types with ABI
+ * version #EINA_MODEL_INTERFACE_VERSION are used by comparing
+ * with the @c version member.
*
* @since 1.2
*/
* @param model The model instance.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * @warning If @a model doesn't implement @a iface does nothing and returns
- * EINA_FALSE.
+ * @warning If @a model doesn't implement @a iface does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_new()
* @see _Eina_Model_Interface
* @param model The model instance.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * @warning If @a model doesn't implement @a iface does nothing and returns
- * EINA_FALSE.
+ * @warning If @a model doesn't implement @a iface does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_del()
* @see _Eina_Model_Interface
* @param dst Pointer to where copy will be put.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * @warning If @a model doesn't implement @a iface does nothing and returns
- * EINA_FALSE.
+ * @warning If @a model doesn't implement @a iface does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_copy()
* @see _Eina_Model_Interface
* @param dst Pointer to where copy will be put.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * @warning If @a model doesn't implement @a iface does nothing and returns
- * EINA_FALSE.
+ * @warning If @a model doesn't implement @a iface does nothing and
+ * returns #EINA_FALSE.
*
* @see eina_model_deep_copy()
* @see _Eina_Model_Interface
* @typedef Eina_Model_Interface_Properties
* Interface to manage model's properties.
*
- * This extends #Eina_Model_Interface as expected by interface name
- * #EINA_MODEL_INTERFACE_NAME_PROPERTIES.
+ * This extends #Eina_Model_Interface as expected by interface
+ * name #EINA_MODEL_INTERFACE_NAME_PROPERTIES.
*
* This interface is meant to help managing properties of a model, it
* is used by #EINA_MODEL_TYPE_MIXIN in order to configure methods for
* @struct _Eina_Model_Interface_Properties
* Interface to manage model's properties.
*
- * This extends #Eina_Model_Interface as expected by interface name
- * #EINA_MODEL_INTERFACE_NAME_PROPERTIES.
+ * This extends #Eina_Model_Interface as expected by interface
+ * name #EINA_MODEL_INTERFACE_NAME_PROPERTIES.
*
* This interface is meant to help managing properties of a model, it
* is used by #EINA_MODEL_TYPE_MIXIN in order to configure methods for
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return EINA_FALSE.
+ * return #EINA_FALSE.
*
* @see eina_model_compare()
* @since 1.2
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return EINA_FALSE.
+ * return #EINA_FALSE.
*
* @see eina_model_load()
* @since 1.2
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return EINA_FALSE.
+ * return #EINA_FALSE.
*
* @see eina_model_unload()
* @since 1.2
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return EINA_FALSE.
+ * return #EINA_FALSE.
*
* @see eina_model_property_get()
* @since 1.2
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return EINA_FALSE.
+ * return #EINA_FALSE.
*
* @see eina_model_property_set()
* @since 1.2
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return EINA_FALSE.
+ * return #EINA_FALSE.
*
* @see eina_model_property_del()
* @since 1.2
* @return #Eina_List of properties' names.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return EINA_FALSE.
+ * return #EINA_FALSE.
*
* @see eina_model_properties_names_list_get()
* @since 1.2
* @typedef Eina_Model_Interface_Children
* Interface to manage model's children.
*
- * This extends #Eina_Model_Interface as expected by interface name
- * #EINA_MODEL_INTERFACE_NAME_CHILDREN.
+ * This extends #Eina_Model_Interface as expected by interface
+ * name #EINA_MODEL_INTERFACE_NAME_CHILDREN.
*
* This interface is meant to help managing properties of a model, it
* is used by #EINA_MODEL_TYPE_MIXIN in order to configure methods for
* @struct _Eina_Model_Interface_Children
* Interface to manage model's children.
*
- * This extends #Eina_Model_Interface as expected by interface name
- * #EINA_MODEL_INTERFACE_NAME_CHILDREN.
+ * This extends #Eina_Model_Interface as expected by interface
+ * name #EINA_MODEL_INTERFACE_NAME_CHILDREN.
*
* This interface is meant to help managing properties of a model, it
* is used by #EINA_MODEL_TYPE_MIXIN in order to configure methods for
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return EINA_FALSE.
+ * return #EINA_FALSE.
*
* @see eina_model_compare()
* @since 1.2
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return EINA_FALSE.
+ * return #EINA_FALSE.
*
* @see eina_model_load()
* @since 1.2
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return EINA_FALSE.
+ * return #EINA_FALSE.
*
* @see eina_model_unload()
* @since 1.2
* @return Number of children in @a model.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return -1.
+ * return @c -1.
*
* @see eina_model_child_count()
* @since 1.2
* @return The requested child.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return -1.
+ * return @c -1.
*
* @see eina_model_child_get()
* @since 1.2
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return -1.
+ * return @c -1.
*
* @see eina_model_child_set()
* @since 1.2
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return -1.
+ * return @c -1.
*
* @see eina_model_child_del()
* @since 1.2
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
- * return -1.
+ * return @c -1.
*
* @see eina_model_child_insert_at()
* @since 1.2
/**
* @var EINA_MODEL_TYPE_MIXIN
*
- * Type that uses #EINA_MODEL_INTERFACE_NAME_PROPERTIES and
- * #EINA_MODEL_INTERFACE_NAME_CHILDREN to manage the model.
+ * Type that uses #EINA_MODEL_INTERFACE_NAME_PROPERTIES
+ * and #EINA_MODEL_INTERFACE_NAME_CHILDREN to manage the model.
*
* This is an abstract type, it does not work out of the box as one
* needs to subclass it and define the interface implementations for
/**
* @var EINA_MODEL_TYPE_GENERIC
*
- * Subclass of #EINA_MODEL_TYPE_MIXIN that uses
- * #EINA_MODEL_INTERFACE_PROPERTIES_HASH and
- * #EINA_MODEL_INTERFACE_CHILDREN_INARRAY.
+ * Subclass of #EINA_MODEL_TYPE_MIXIN that
+ * uses #EINA_MODEL_INTERFACE_PROPERTIES_HASH
+ * and #EINA_MODEL_INTERFACE_CHILDREN_INARRAY.
*
* Should be generic enough to hold lots of items with runtime
* configurable properties of any type.
/**
* @var EINA_MODEL_TYPE_STRUCT
*
- * Subclass of #EINA_MODEL_TYPE_MIXIN that uses
- * #EINA_MODEL_INTERFACE_PROPERTIES_STRUCT and
- * #EINA_MODEL_INTERFACE_CHILDREN_INARRAY.
+ * Subclass of #EINA_MODEL_TYPE_MIXIN that
+ * uses #EINA_MODEL_INTERFACE_PROPERTIES_STRUCT
+ * and #EINA_MODEL_INTERFACE_CHILDREN_INARRAY.
*
* Should be struct enough to hold lots of items with compile time
* configurable properties of any type.
/**
* @var EINA_MODEL_INTERFACE_NAME_PROPERTIES
*
- * Interface that uses #Eina_Model_Interface_Properties as
- * #Eina_Model_Interface and can manage the model properties.
+ * Interface that uses #Eina_Model_Interface_Properties
+ * as #Eina_Model_Interface and can manage the model properties.
*
* @since 1.2
*/
* Implements #Eina_Model_Interface_Properties
* (#EINA_MODEL_INTERFACE_NAME_PROPERTIES) using #Eina_Value_Struct.
*
- * The interface private data is #Eina_Value of type
- * #EINA_VALUE_TYPE_STRUCT. Properties will be accessed using
+ * The interface private data is #Eina_Value of
+ * type #EINA_VALUE_TYPE_STRUCT. Properties will be accessed using
* Eina_Value_Struct::desc information that can be set by types such
* as #EINA_MODEL_TYPE_STRUCT
*
/**
* @var EINA_MODEL_INTERFACE_NAME_CHILDREN
*
- * Interface that uses #Eina_Model_Interface_Children as
- * #Eina_Model_Interface and can manage the model children.
+ * Interface that uses #Eina_Model_Interface_Children
+ * as #Eina_Model_Interface and can manage the model children.
*
* @since 1.2
*/
/**
* @def EINA_MODULE_SHUTDOWN
* declares the given function as the module shutdownializer
- * (__eina_module_shutdown). It must be of signature
- * #Eina_Module_Shutdown
+ * (__eina_module_shutdown). It must be of signature #Eina_Module_Shutdown
*/
#define EINA_MODULE_SHUTDOWN(f) EAPI Eina_Module_Shutdown __eina_module_shutdown = &f
* eina_module_new(). If it is a internal Eina module (like the
* mempools), it also initialize it. It the shared file object can not
* be loaded, the error #EINA_ERROR_WRONG_MODULE is set and
- * #EINA_FALSE is returned. If it is a internal Eina module and the
- * module can not be initialized, the error
- * #EINA_ERROR_MODULE_INIT_FAILED is set and #EINA_FALSE is
- * returned. If the module has already been loaded, it's reference
- * counter is increased by one and #EINA_TRUE is returned. If @p module is
- * @c NULL, the function returns immediately #EINA_FALSE.
+ * and #EINA_FALSE is returned. If it is a internal Eina module and the
+ * module can not be initialized, the error #EINA_ERROR_MODULE_INIT_FAILED
+ * is set and #EINA_FALSE is returned. If the module has already been loaded,
+ * it's reference counter is increased by one and #EINA_TRUE is returned.
+ * If @p module is @c NULL, the function returns immediately #EINA_FALSE.
*
* When the symbols of the shared file objects are not needed
* anymore, call eina_module_unload() to unload the module.
* NULL, this function still returns a 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 and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
+ * 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.
*
* @warning if the rbtree structure changes then the iterator becomes
* NULL, this function still returns a 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 and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
+ * 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.
*
* @warning if the rbtree structure changes then the iterator becomes
* NULL, this function still returns a 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 and
- * #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
+ * 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.
*
* @warning if the rbtree structure changes then the iterator becomes
* This function appends @p str to @p buf. It computes the length of
* @p str, so is slightly slower than eina_strbuf_append_length(). If
* the length is known beforehand, consider using that variant. If
- * @p buf can't append it, #EINA_FALSE is returned, otherwise
- * #EINA_TRUE is returned.
+ * @p buf can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
+ * returned.
*
* @see eina_strbuf_append()
* @see eina_strbuf_append_length()
* @param c The char to append.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * This function inserts @p c to @p buf. If it can not insert it,
- * #EINA_FALSE is returned, otherwise #EINA_TRUE is returned.
+ * This function inserts @p c to @p buf. If it can not insert it, #EINA_FALSE
+ * is returned, otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool eina_strbuf_append_char(Eina_Strbuf *buf, char c) EINA_ARG_NONNULL(1);
*
* This function insert 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.
+ * functions. If it can't insert it, #EINA_FALSE is returned,
+ * otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool eina_strbuf_insert_printf(Eina_Strbuf *buf, const char *fmt, size_t pos, ...) EINA_ARG_NONNULL(1, 2) EINA_PRINTF(2, 4);
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_strbuf_insert_escaped() at position 0. If
- * @p buf can't prepend it, #EINA_FALSE is returned, otherwise
- * #EINA_TRUE is returned.
+ * @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
+ * returned.
*/
#define eina_strbuf_prepend_escaped(buf, str) eina_strbuf_insert_escaped(buf, str, 0)
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_strbuf_insert_n() at position 0. If
- * @p buf can't prepend it, #EINA_FALSE is returned, otherwise
- * #EINA_TRUE is returned.
+ * @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
+ * returned.
*/
#define eina_strbuf_prepend_n(buf, str, maxlen) eina_strbuf_insert_n(buf, str, maxlen, 0)
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_strbuf_insert_length() at position 0. If
- * @p buf can't prepend it, #EINA_FALSE is returned, otherwise
- * #EINA_TRUE is returned.
+ * @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
+ * returned.
*/
#define eina_strbuf_prepend_length(buf, str, length) eina_strbuf_insert_length(buf, str, length, 0)
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_strbuf_insert_char() at position 0. If
- * @p buf can't prepend it, #EINA_FALSE is returned, otherwise
- * #EINA_TRUE is returned.
+ * @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE
+ * is returned.
*/
#define eina_strbuf_prepend_char(buf, c) eina_strbuf_insert_char(buf, c, 0)
*
* The region defined by @a x, @a y, @a w, @a h will be divided in to a grid of
* tiles of width @a tile_w and height @p tile_h, the returned iterator will
- * iterate over every tile in the grid having as its data a
- * #Eina_Tile_Grid_Info.
+ * iterate over every tile in the grid having as its data a #Eina_Tile_Grid_Info.
*
* @note This is a convenience function, iterating over the returned iterator is
* equivalent to calling eina_tile_grid_slicer_setup() and calling
* This function appends @p str to @p buf. It computes the length of
* @p str, so is slightly slower than eina_ustrbuf_append_length(). If
* the length is known beforehand, consider using that variant. If
- * @p buf can't append it, #EINA_FALSE is returned, otherwise
- * #EINA_TRUE is returned.
+ * @p buf can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
+ * returned.
*
* @see eina_ustrbuf_append()
* @see eina_ustrbuf_append_length()
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This function appends the escaped string @p str to @p buf. If @p
- * str can not be appended, #EINA_FALSE is returned, otherwise,
- * #EINA_TRUE is returned.
+ * str can not be appended, #EINA_FALSE is returned, otherwise, #EINA_TRUE is
+ * returned.
*/
EAPI Eina_Bool eina_ustrbuf_append_escaped(Eina_UStrbuf *buf, const Eina_Unicode *str) EINA_ARG_NONNULL(1, 2);
* @param c The char to append.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * This function inserts @p c to @p buf. If it can not insert it,
- * #EINA_FALSE is returned, otherwise #EINA_TRUE is returned.
+ * This function inserts @p c to @p buf. If it can not insert it, #EINA_FALSE
+ * is returned, otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool eina_ustrbuf_append_char(Eina_UStrbuf *buf, Eina_Unicode c) EINA_ARG_NONNULL(1);
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_ustrbuf_insert_escaped() at position 0. If
- * @p buf can't prepend it, #EINA_FALSE is returned, otherwise
- * #EINA_TRUE is returned.
+ * @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
+ * returned.
*/
#define eina_ustrbuf_prepend_escaped(buf, str) eina_ustrbuf_insert_escaped(buf, str, 0)
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_ustrbuf_insert_n() at position 0. If
- * @p buf can't prepend it, #EINA_FALSE is returned, otherwise
- * #EINA_TRUE is returned.
+ * @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
+ * returned.
*/
#define eina_ustrbuf_prepend_n(buf, str, maxlen) eina_ustrbuf_insert_n(buf, str, maxlen, 0)
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_ustrbuf_insert_length() at position 0. If
- * @p buf can't prepend it, #EINA_FALSE is returned, otherwise
- * #EINA_TRUE is returned.
+ * @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
+ * returned.
*/
#define eina_ustrbuf_prepend_length(buf, str, length) eina_ustrbuf_insert_length(buf, str, length, 0)
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_ustrbuf_insert_Eina_Unicode *() at position 0. If
- * @p buf can't prepend it, #EINA_FALSE is returned, otherwise
- * #EINA_TRUE is returned.
+ * @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
+ * returned.
*/
#define eina_ustrbuf_prepend_char(buf, c) eina_ustrbuf_insert_char(buf, c, 0)
* pointer to an #Eina_Value_Array. For your convenience, use
* eina_value_array_setup().
*
- * eina_value_get() and eina_value_pget() takes a pointer to
- * #Eina_Value_Array, it's an exact copy of the current structure in
+ * eina_value_get() and eina_value_pget() takes a pointer
+ * to #Eina_Value_Array, it's an exact copy of the current structure in
* use by value, no copies are done.
*
* @since 1.2
* eina_value_set() takes an #Eina_Value_List where just @c subtype is
* used. If there is an @c list, it will be copied (including each
* item) and its contents must be properly configurable as @c
- * subtype expects. eina_value_pset() takes a pointer to an
- * #Eina_Value_List. For your convenience, use
- * eina_value_list_setup().
+ * subtype expects. eina_value_pset() takes a pointer to an #Eina_Value_List.
+ * For your convenience, use eina_value_list_setup().
*
- * eina_value_get() and eina_value_pget() takes a pointer to
- * #Eina_Value_List, it's an exact copy of the current structure in
- * use by value, no copies are done.
+ * eina_value_get() and eina_value_pget() takes a pointer to #Eina_Value_List,
+ * it's an exact copy of the current structure in use by value, no copies are
+ * done.
*
* @since 1.2
*/
* takes a pointer to an #Eina_Value_Hash. For your convenience, use
* eina_value_hash_setup().
*
- * eina_value_get() and eina_value_pget() takes a pointer to
- * #Eina_Value_Hash, it's an exact copy of the current structure in
- * use by value, no copies are done.
+ * eina_value_get() and eina_value_pget() takes a pointer to #Eina_Value_Hash,
+ * it's an exact copy of the current structure in use by value, no copies are
+ * done.
*
* @note be aware that hash data is always an allocated memory of size
* defined by @c subtype->value_size. If your @c subtype is an
* eina_value_set() takes an #Eina_Value_Blob
* eina_value_pset() takes a pointer to #Eina_Value_Blob.
*
- * eina_value_get() and eina_value_pget() takes a pointer to
- * #Eina_Value_Blob and it's an exact copy of value, no allocations
- * are made.
+ * eina_value_get() and eina_value_pget() takes a pointer to #Eina_Value_Blob
+ * and it's an exact copy of value, no allocations are made.
*
* Memory is untouched unless you provide @c ops (operations) pointer.
*
* eina_value_set() takes an #Eina_Value_Struct where just @c desc is
* used. If there is an @c memory, it will be copied (including each
* member) and its contents must be properly configurable as @c desc
- * expects. eina_value_pset() takes a pointer to an
- * #Eina_Value_Struct. For your convenience, use
- * eina_value_struct_setup().
+ * expects. eina_value_pset() takes a pointer to an #Eina_Value_Struct. For
+ * your convenience, use eina_value_struct_setup().
*
- * eina_value_get() and eina_value_pget() takes a pointer to
- * #Eina_Value_Struct, it's an exact copy of the current structure in
+ * eina_value_get() and eina_value_pget() takes a pointer
+ * to #Eina_Value_Struct, it's an exact copy of the current structure in
* use by value, no copies are done.
*
* @since 1.2
* eg. #EINA_VALUE_TYPE_ARRAY uses eina_value_array_set(),
* eina_value_array_get() and so on.
*
- * On failure, @c NULL is returned and either #EINA_ERROR_OUT_OF_MEMORY or
- * #EINA_ERROR_VALUE_FAILED is set.
+ * On failure, @c NULL is returned and either #EINA_ERROR_OUT_OF_MEMORY
+ * or #EINA_ERROR_VALUE_FAILED is set.
*
* @note this calls creates from mempool and then uses
* eina_value_setup(). Consider using eina_value_flush() and
* Initializes existing generic value storage. The members are managed using the
* description specified by @a type.
*
- * Some types may specify more operations, as an example
- * #EINA_VALUE_TYPE_ARRAY uses eina_value_array_set(),
- * eina_value_array_get() and so on.
+ * Some types may specify more operations, as an example #EINA_VALUE_TYPE_ARRAY
+ * uses eina_value_array_set(), eina_value_array_get() and so on.
*
* @note Existing contents are ignored! If the value was previously used, then
* use eina_value_flush() first.
* Create a new generic value storage of type array. The members are
* managed using the description specified by @a subtype.
*
- * On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY or
- * #EINA_ERROR_VALUE_FAILED is set.
+ * On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY
+ * or #EINA_ERROR_VALUE_FAILED is set.
*
* @note this creates from mempool and then uses
* eina_value_array_setup(). @see eina_value_free() @see
* Initializes new generic value storage of type array with the given
* @a subtype.
*
- * This is the same as calling eina_value_set() with
- * #EINA_VALUE_TYPE_ARRAY followed by eina_value_pset() with the
- * #Eina_Value_Array description configured.
+ * This is the same as calling eina_value_set()
+ * with #EINA_VALUE_TYPE_ARRAY followed by eina_value_pset() with
+ * the #Eina_Value_Array description configured.
*
* @note Existing contents are ignored! If the value was previously used, then
* use eina_value_flush() first.
* Create a new generic value storage of type list. The members are
* managed using the description specified by @a subtype.
*
- * On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY or
- * #EINA_ERROR_VALUE_FAILED is set.
+ * On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY
+ * or #EINA_ERROR_VALUE_FAILED is set.
*
* @note this creates from mempool and then uses
* eina_value_list_setup().
* Initializes new generic value storage of type list with the given
* @a subtype.
*
- * This is the same as calling eina_value_set() with
- * #EINA_VALUE_TYPE_LIST followed by eina_value_pset() with the
- * #Eina_Value_List description configured.
+ * This is the same as calling eina_value_set()
+ * with #EINA_VALUE_TYPE_LIST followed by eina_value_pset() with
+ * the #Eina_Value_List description configured.
*
* @note Existing contents are ignored! If the value was previously used, then
* use eina_value_flush() first.
* Create a new generic value storage of type hash. The members are
* managed using the description specified by @a subtype.
*
- * On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY or
- * #EINA_ERROR_VALUE_FAILED is set.
+ * On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY
+ * or #EINA_ERROR_VALUE_FAILED is set.
*
* @note this creates from mempool and then uses
* eina_value_hash_setup().
* Initializes new generic value storage of type hash with the given
* @a subtype.
*
- * This is the same as calling eina_value_set() with
- * #EINA_VALUE_TYPE_HASH followed by eina_value_pset() with the
- * #Eina_Value_Hash description configured.
+ * This is the same as calling eina_value_set()
+ * with #EINA_VALUE_TYPE_HASH followed by eina_value_pset() with
+ * the #Eina_Value_Hash description configured.
*
* @note Existing contents are ignored! If the value was previously used, then
* use eina_value_flush() first.
* specified as _Eina_Value_Struct_Operations::find_member(). For
* structures with huge number of members, consider using a better
* find_member function to quickly finding it! There are two helper
- * operations provided to help this:
- * #EINA_VALUE_STRUCT_OPERATIONS_BINSEARCH and
- * #EINA_VALUE_STRUCT_OPERATIONS_STRINGSHARE, both depend on properly
+ * operations provided to help this: #EINA_VALUE_STRUCT_OPERATIONS_BINSEARCH
+ * and #EINA_VALUE_STRUCT_OPERATIONS_STRINGSHARE, both depend on properly
* set #_Eina_Value_Struct_Desc and #_Eina_Value_Struct_Member.
*
* @see #EINA_VALUE_STRUCT_MEMBER
* Create a new generic value storage of type struct. The members are
* managed using the description specified by @a desc.
*
- * On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY or
- * #EINA_ERROR_VALUE_FAILED is set.
+ * On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY
+ * or #EINA_ERROR_VALUE_FAILED is set.
*
* @note this creates from mempool and then uses
* eina_value_struct_setup().
* Initializes new generic value storage of type struct with the given
* @a desc.
*
- * This is the same as calling eina_value_set() with
- * #EINA_VALUE_TYPE_STRUCT followed by eina_value_pset() with the
- * #Eina_Value_Struct description configured.
+ * This is the same as calling eina_value_set()
+ * with #EINA_VALUE_TYPE_STRUCT followed by eina_value_pset() with
+ * the #Eina_Value_Struct description configured.
*
* @note Existing contents are ignored! If the value was previously used, then
* use eina_value_flush() first.
* eina_init().
*
* This function sets up the error module of Eina and registers the
- * errors #EINA_ERROR_CONVERT_0X_NOT_FOUND,
- * #EINA_ERROR_CONVERT_P_NOT_FOUND and
- * #EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH.
+ * errors #EINA_ERROR_CONVERT_0X_NOT_FOUND, #EINA_ERROR_CONVERT_P_NOT_FOUND
+ * and #EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH.
*
* @see eina_init()
*/
* called by eina_init().
*
* This function sets up the module module of Eina. It also registers
- * the errors #EINA_ERROR_WRONG_MODULE and
- * #EINA_ERROR_MODULE_INIT_FAILED.
+ * the errors #EINA_ERROR_WRONG_MODULE and #EINA_ERROR_MODULE_INIT_FAILED.
*
* @see eina_init()
*/
* This function appends @p str to @p buf. It computes the length of
* @p str, so is slightly slower than eina_strbuf_common_append_length(). If
* the length is known beforehand, consider using that variant. If
- * @p buf can't append it, #EINA_FALSE is returned, otherwise
- * #EINA_TRUE is returned.
+ * @p buf can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
+ * returned.
*
* @see eina_strbuf_common_append()
* @see eina_strbuf_common_append_length()
* @param c The char to append.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
- * This function inserts @p c to @p buf. If it can not insert it,
- * #EINA_FALSE is returned, otherwise #EINA_TRUE is returned.
+ * This function inserts @p c to @p buf. If it can not insert it, #EINA_FALSE
+ * is returned, otherwise #EINA_TRUE is returned.
*/
Eina_Bool
eina_strbuf_common_append_char(size_t csize, Eina_Strbuf *buf, const void *c)
projects / framework / uifw / eina.git / commitdiff