* should call ecore_init() first, then register your callback on
* @c EFL_LOOP_EVENT_ARGUMENTS and finally call ecore_init_ex().
*
- * Once you are shuting down your program, you should symetrically
+ * Once you are shuting down your program, you should symmetrically
* call ecore_shutdown_ex().
*/
EAPI unsigned int ecore_init_ex(int argc, char **argv);
/**
* @typedef Ecore_Cocoa_Object
- * Opaque handler to refer to an objective-c object (aka id)
+ * Opaque handler to refer to an objective-c object (a.k.a. id)
* @since 1.18
*/
typedef void Ecore_Cocoa_Object;
*
* @param types a null-terminated array of mimetypes supported by the client
*
- * @return serial of request on sucess, 0 on failure
+ * @return serial of request on success, 0 on failure
*
* @ingroup Ecore_Wl2_Dnd_Group
* @since 1.17
*
* @param input the input to clear
*
- * @return serial of request on sucess, 0 on failure
+ * @return serial of request on success, 0 on failure
*
* @ingroup Ecore_Wl2_Dnd_Group
* @since 1.17
//this API for keyrouter protocol
EAPI void ecore_x_e_keyrouter_set(Ecore_X_Window root, Eina_Bool on); /**< @since 1.15 */ //Key router set keyrouter flag using this
-EAPI Eina_Bool ecore_x_e_keyrouter_get(Ecore_X_Window root); /**< @since 1.15 */ //Client check the existance of keyrouter using this
+EAPI Eina_Bool ecore_x_e_keyrouter_get(Ecore_X_Window root); /**< @since 1.15 */ //Client check the existence of keyrouter using this
#ifdef EFL_BETA_API_SUPPORT
// XXX: FIXME: re-evaluate this after looking at xdg foreign in wayland
/**
* @typedef Ector_Colorspace
- * The definiton of colorspace.
+ * The definition of colorspace.
*/
// FIXME: Enable this when we have merged Emile
/* typedef Evas_Colorspace Ector_Colorspace; */
*
* This function thaws the given Edje object.
*
- * @note If sucessive freezes were done, an equal number of thaws will be
+ * @note If successive freezes were done, an equal number of thaws will be
* required.
*
* See also @ref edje_object_freeze()
Old_Edje_Part_Collection *oedc);
/**
- * Convert old Edje part descripton into new format.
+ * Convert old Edje part description into new format.
*
* @param type The edje par description common type
* @param ce an edje collection directory entry
- * @param the old edje part descripton
+ * @param the old edje part description
*
- * @return a new edje part descripton common
+ * @return a new edje part description common
*/
Edje_Part_Description_Common *_edje_description_convert(int type,
Edje_Part_Collection_Directory_Entry *ce,
/**
* @ingroup Eet_File_Image_Group
- * @brief Gets the colorspace Eet can decode into of a given eet image ressource.
+ * @brief Gets the colorspace Eet can decode into of a given eet image resource.
*
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
*
* @return An Eina_Value to pass to the next Eina_Future in the chain (if any).
* If there is no need to convert the received value, it's @b recommended
- * to pass-thru @p value argument. If you need to convert to a different type
+ * to passthrough @p value argument. If you need to convert to a different type
* or generate a new value, use @c eina_value_setup() on @b another Eina_Value
* and return it. By returning a promise Eina_Value (eina_promise_as_value()) the
* whole chain will wait until the promise is resolved in
* @param[in] value The operation result
* @return An Eina_Value to pass to the next Eina_Future in the chain (if any).
* If there is no need to convert the received value, it's @b recommended
- * to pass-thru @p value argument. If you need to convert to a different type
+ * to passthrough @p value argument. If you need to convert to a different type
* or generate a new value, use @c eina_value_setup() on @b another Eina_Value
* and return it. By returning a promise Eina_Value (eina_promise_as_value()) the
* whole chain will wait until the promise is resolved in
* may also return a non-error, in this case the next future in chain will receive a regular
* value, which may call its @c success.
*
- * If this function is not provided, then it will pass thru the error to the next error handler.
+ * If this function is not provided, then it will passthrough the error to the next error handler.
*
* It may be called with @c EINVAL if @c success_type is provided and doesn't
* match the received type.
*
* This iterator contains also the canvas objects which are part of the widgets,
* be aware that the construction of this tree is internal and might change heavily
- * inbetween versions.
+ * between versions.
*
* @param obj The widget which is the root of the subtree.
*
EAPI void elm_config_vsync_set(Eina_Bool enabled);
/**
- * Get the configure flag that will define if a window agressively drop its
- * ressource when minimized.
+ * Get the configure flag that will define if a window aggressively drop its
+ * resources when minimized.
*
* @return if it does.
*
EAPI Eina_Bool elm_config_agressive_withdrawn_get(void);
/**
- * Set the configure flag that will make a window agressively drop its
- * ressource when minimized.
+ * Set the configure flag that will make a window aggressively drop its
+ * resources when minimized.
*
* @param enabled This should be @c EINA_TRUE if enabled, or @c EINA_FALSE if
* not.
*
* @note Be careful to not manipulate it, as it is under control of elementary.
*
- * @warning It doesn't gurantee the inlined object must be a type of Evas_Object_Image.
+ * @warning It doesn't guarantee the inlined object must be a type of Evas_Object_Image.
* It would be one of @c Evas_Object_Image or @c Edje_Object depending
on image file type.
*
/**
* Request that your elementary application needs eldbus
*
- * This initializes the eldbus (aka v2) library when called and if
+ * This initializes the eldbus (a.k.a. v2) library when called and if
* support exists it returns @c EINA_TRUE, otherwise returns
* @c EINA_FALSE. This must be called before any eldbus calls.
*
/**
* @brief Set the notifications server to be used.
*
- * @note This is an advanced function that should be used only to fullfill very
+ * @note This is an advanced function that should be used only to fulfill very
* specific purposes. Use elm_need_sys_notify() which activates the default
* available notification servers.
*
/**
* @brief Set the notifications server to be used.
*
- * @note This is an advanced function that should be used only to fullfill very
+ * @note This is an advanced function that should be used only to fulfill very
* specific purposes. Use elm_need_sys_notify() which activates the default
* available notification servers.
*
* input manager. Setting a window on the input manager is done so that
* when we raise events (mouse movement, keyboard key, etc) then this
* window is passed to the event structure as the window which the event
- * occured on.
+ * occurred on.
*
* @param manager
* @param window
* @param device
* @param enabled
*
- * @return EINA_TRUE on sucess, EINA_FALSE otherwise
+ * @return EINA_TRUE on success, EINA_FALSE otherwise
*
* @ingroup Elput_Touch_Group
* @since 1.19
/**
* @enum _Emile_Action
* @typedef Emile_Action
- * What action emile is refering to.
+ * What action emile is referring to.
* @since 1.19
*/
typedef enum _Emile_Action
int smooth;
/* This should have never been part of this structure, but we keep it
- for ABI/API compability with Evas_Loader */
+ for ABI/API compatibility with Evas_Loader */
Emile_Image_Scale_Hint scale_hint;
} scale_load;
double dpi;
/**
* @enum Emotion_Suspend
*
- * Used for emotion pipeline ressource management.
+ * Used for emotion pipeline resource management.
*
* @see emotion_object_suspend_set()
* @see emotion_object_suspend_get()
typedef enum
{
EMOTION_WAKEUP, /**< pipeline is up and running */
- EMOTION_SLEEP, /**< turn off hardware ressource usage like overlay */
+ EMOTION_SLEEP, /**< turn off hardware resource usage like overlay */
EMOTION_DEEP_SLEEP, /**< destroy the pipeline, but keep full resolution pixels output around */
EMOTION_HIBERNATE /**< destroy the pipeline, and keep half resolution or object resolution if lower */
} Emotion_Suspend;
*/
/**
- * @defgroup Emotion_Ressource Video ressource management
+ * @defgroup Emotion_Ressource Video resource management
*/
/**
* Picture in Picture is needed. And most application just have a few video stream that really
* deserve high frame rate, high quality output. That's why this call is for.
*
- * Please note that if Emotion can't acquire a priviledged hardware ressource, it will fallback
+ * Please note that if Emotion can't acquire a priviledged hardware resource, it will fallback
* to the no-priority path. This work on the first asking first get basis system.
*
* @see emotion_object_priority_get()
* @param value The operation result
* @return An Eina_Value to pass to the next Eina_Future in the chain (if any).
* If there is no need to convert the received value, it's @b recommended
- * to pass-thru @p value argument. If you need to convert to a different type
+ * to passthrough @p value argument. If you need to convert to a different type
* or generate a new value, use @c eina_value_setup() on @b another Eina_Value
* and return it. By returning a promise Eina_Value (eina_promise_as_value()) the
* whole chain will wait until the promise is resolved in
* may also return a non-error, in which case the next future in the chain will receive a regular
* value, which may call its @c success.
*
- * If this function is not provided, then it will pass thru the error to the next error handler.
+ * If this function is not provided, then it will passthrough the error to the next error handler.
*
* It may be called with @c EINVAL if @c success_type is provided and doesn't
* match the received type.
EAPI Eina_Stringshare *eolian_typedecl_free_func_get(const Eolian_Typedecl *tp);
/*
- * @breif Get the function object for this function pointer type.
+ * @brief Get the function object for this function pointer type.
*
* @param[in] tp the type.
* @return the function or NULL;
/**
* @brief Get all implementations of a function in a state.
*
- * Given a function and a childen hierarchy from
+ * Given a function and a children hierarchy from
* eolian_aux_state_class_children_find(), this will func
* all implementations of that function in the system. This
* is useful for various utilities. You need to free the list
int eo_lexer_lookahead (Eo_Lexer *ls);
/* "throws" an error, with a custom message and custom token */
void eo_lexer_lex_error (Eo_Lexer *ls, const char *msg, int token);
-/* like above, but uses the lexstate->t.token, aka current token */
+/* like above, but uses the lexstate->t.token, a.k.a. current token */
void eo_lexer_syntax_error (Eo_Lexer *ls, const char *msg);
/* turns the token into a string, writes into the given buffer */
void eo_lexer_token_to_str (int token, char *buf);
* Return the length of the quaternion.
*
* @param quat Quaternion to get length of.
- * @return The lenght of @p quat or @c 0 on error.
+ * @return The length of @p quat or @c 0 on error.
*
* @ingroup EPhysics_Quaternion
*/
* Return the length squared of the quaternion.
*
* @param quat Quaternion to get length of.
- * @return The lenght of @p quat or @c 0 on error.
+ * @return The length of @p quat or @c 0 on error.
*
* @ingroup EPhysics_Quaternion
*/
* @ref ephysics_shape_save(). With that shapes can be done or visualized
* on design applications.
*
- * @note Using primitive shapes has better perfomance than generic shapes.
+ * @note Using primitive shapes has better performance than generic shapes.
* @note For now, only convex shapes are supported.
*
*/
*
* While dragging a soft body the user may want to freeze a specific trimesh
* face, after calling this function EPhysics will do freeze the @p triangle
- * untill it gets a call to unset it with
+ * until it gets a call to unset it with
* ephysics_body_soft_body_dragging_unset().
*
* @note Freezing a specific trimesh face means no forces are applied to it, no
- * gravity enforced, that's @p triangle will have no mass untill it dragging
+ * gravity enforced, that's @p triangle will have no mass until it dragging
* gets unset.
*
* @param body The body of interest.
* Unmaps a mapped view of a file from the calling process's
* address space. @p addr is the pointer to the base address.
* This value must be identical to the value returned by a
- * previous call to mmap(). The parameter @p len is unsed.
+ * previous call to mmap(). The parameter @p len is unused.
*
* Conformity: None.
*
* @param data extra context given to ethumb_client_thumb_exists().
*
* During the execution of the callback the state of the @p client is
- * temporarily realy restored to what it was when the call to
+ * temporarily really restored to what it was when the call to
* ethumb_client_thumb_exists() was done.
*/
typedef void (*Ethumb_Client_Thumb_Exists_Cb)(void *data, Ethumb_Client *client, Ethumb_Exists *thread, Eina_Bool exists);
* @param e The canvas to find the device on
* @param name The name of the device.
*
- * Gets the first ocurrence of a device named as @p name
+ * Gets the first occurrence of a device named as @p name
* on Evas @p e list of devices.
*
* @return the device or NULL if an error occurred, no name was provided,
EAPI void evas_object_image_load_head_skip_set(Evas_Object *obj, Eina_Bool skip);
/**
- * @breif Get the load option to skip header loads before preload
+ * @brief Get the load option to skip header loads before preload
*
* This gets the heade skip value set by evas_object_image_load_head_skip_set()
*
#define EVAS_TP_SZLEN_ONE 1
// special case textprop for ONE char! should use this for textgrid but
-// we have to modify every bit of code that usea a textprop to go thru a
+// we have to modify every bit of code that usea a textprop to go through a
// getter or setter etc. etc.
struct _Evas_Text_Props_One
{
/**
* @typedef Dl_info
- * @brief A structure that stores infomation of a calling process.
+ * @brief A structure that stores information of a calling process.
* This typedef is defined only when _GNU_SOURCE was defined before
* including dlfcn.h.
*/
/**
* @struct Dl_info
- * @brief A structure that stores infomation of a calling process.
+ * @brief A structure that stores information of a calling process.
* This structure is defined only when _GNU_SOURCE was defined before
* including dlfcn.h.
*/
* @brief Close a dynamic-link library.
*
* @param handle Handle that references a dynamic-link library.
- * @return O on sucess, -1 otherwise.
+ * @return O on success, -1 otherwise.
*
* Release a reference to the dynamic-link library referenced
* by @p handle. If the reference count drops to 0, the handle is
*
* @param handle Handle that references a dynamic-link library.
* @param symbol @c NULL-terminated string.
- * @return O on sucess, NULL otherwise.
+ * @return O on success, NULL otherwise.
*
* Return the address of the code or data location specified by the
* string @p symbol. @p handle references a library that contains
* by @p resolved_name. The buffer is at most @c PATH_MAX bytes long.
* If @p resolved_name is @c NULL, malloc() is used to allocate a
* buffer of sufficient length to hold the path name. In that case, it
- * is the responsability of the caller to free this buffer with free().
+ * is the responsibility of the caller to free this buffer with free().
*
* That function can be used to obtain the absolute path name for
* relative paths (relPath) that include "./" or "../" in their names.
* Unmaps a mapped view of a file from the calling process's
* address space. @p addr is the pointer to the base address.
* This value must be identical to the value returned by a
- * previous call to mmap(). The parameter @p len is unsed.
+ * previous call to mmap(). The parameter @p len is unused.
*
* Conformity: None.
*
projects / platform / upstream / efl.git / commitdiff