docs: Fix typos in API reference doc and comments.

Reviewers: Hermet, segfaultxavi

Reviewed By: Hermet, segfaultxavi

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D6948
This commit is contained in:
Yeongjong Lee 2018-08-31 17:45:31 +09:00 committed by Hermet Park
parent b224cecf90
commit 02d83ebcd4
19 changed files with 26 additions and 26 deletions

View File

@ -32,7 +32,7 @@ main(void)
char *engine_name; char *engine_name;
/* Initialize Evas. This will startup other dependencies such as /* Initialize Evas. This will startup other dependencies such as
* eina, eet, ecore, etc. and initalizes various internal things * eina, eet, ecore, etc. and initializes various internal things
* (threads, filters, etc.) */ * (threads, filters, etc.) */
evas_init(); evas_init();

View File

@ -25,7 +25,7 @@ class Efl.Io.Copier (Efl.Loop_Consumer, Efl.Io.Closer) {
reported as data when it's read from @.source). reported as data when it's read from @.source).
- The "line" event is only emitted when @.line_delimiter is - The "line" event is only emitted when @.line_delimiter is
set and not empty. It's simiar to "data". set and not empty. It's similar to "data".
- The "done" event is emitted if @.source is - The "done" event is emitted if @.source is
@Efl.Io.Reader.eos $true and all data was written to @Efl.Io.Reader.eos $true and all data was written to

View File

@ -22,7 +22,7 @@ static const char *_ecore_fb_li_kbd_syms[144 * 7] =
* operation with a byte that only has the relevant bit set. * operation with a byte that only has the relevant bit set.
* eg. to check for the 12th bit, we do (array[1] & 1<<4). * eg. to check for the 12th bit, we do (array[1] & 1<<4).
* Moved to static inline in order to force compiler to otimized * Moved to static inline in order to force compiler to otimized
* the unsued part away or force a link error if long has an unexpected * the unused part away or force a link error if long has an unexpected
* size. * size.
* - bigeasy * - bigeasy
*/ */

View File

@ -1721,7 +1721,7 @@ EAPI Ecore_Wl2_Drag_Action ecore_wl2_offer_actions_get(Ecore_Wl2_Offer *offer);
* *
* @param offer Offer object to use * @param offer Offer object to use
* @param actions A or´ed value of mutliple Ecore_Wl2_Drag_Action values * @param actions A or´ed value of mutliple Ecore_Wl2_Drag_Action values
* @param action the preffered action out of the actions * @param action the preferred action out of the actions
* *
* @ingroup Ecore_Wl2_Dnd_Group * @ingroup Ecore_Wl2_Dnd_Group
* @since 1.19 * @since 1.19
@ -1733,7 +1733,7 @@ EAPI void ecore_wl2_offer_actions_set(Ecore_Wl2_Offer *offer, Ecore_Wl2_Drag_Act
* *
* @param offer Offer object to use * @param offer Offer object to use
* *
* @return the prefered action * @return the preferred action
* *
* @ingroup Ecore_Wl2_Dnd_Group * @ingroup Ecore_Wl2_Dnd_Group
* @since 1.19 * @since 1.19

View File

@ -31,7 +31,7 @@ enum Edje.Cursor {
selection_begin, [[Selection begin cursor state]] selection_begin, [[Selection begin cursor state]]
selection_end, [[Selection end cursor state]] selection_end, [[Selection end cursor state]]
preedit_start, [[Pre-edit start cursor state]] preedit_start, [[Pre-edit start cursor state]]
preedit_end, [[Pre-edit end cursor starge]] preedit_end, [[Pre-edit end cursor state]]
user, [[User cursor state]] user, [[User cursor state]]
user_extra [[User extra cursor state]] user_extra [[User extra cursor state]]
} }
@ -70,7 +70,7 @@ enum Edje.Input_Panel.Lang {
} }
enum Edje.Input_Panel.Return_Key_Type { enum Edje.Input_Panel.Return_Key_Type {
[[Input panel retrun key types]] [[Input panel return key types]]
default, [[Default default, [[Default
@since 1.2]] @since 1.2]]

View File

@ -152,7 +152,7 @@ eeze_sensor_modules_unload(void)
} }
/* This function is offered to the modules to register itself after they have /* This function is offered to the modules to register itself after they have
* been loaded in initialized. They stay in the hash funtion until they * been loaded in initialized. They stay in the hash function until they
* unregister themself. * unregister themself.
*/ */
EAPI Eina_Bool EAPI Eina_Bool

View File

@ -9,7 +9,7 @@ enum Efl.Text_Cursor_Get_Type {
selection_begin, [[Selection begin cursor state]] selection_begin, [[Selection begin cursor state]]
selection_end, [[Selection end cursor state]] selection_end, [[Selection end cursor state]]
preedit_start, [[Pre-edit start cursor state]] preedit_start, [[Pre-edit start cursor state]]
preedit_end, [[Pre-edit end cursor starge]] preedit_end, [[Pre-edit end cursor state]]
user, [[User cursor state]] user, [[User cursor state]]
user_extra [[User extra cursor state]] user_extra [[User extra cursor state]]
} }

View File

@ -99,7 +99,7 @@ EAPI char *eina_vpath_resolve(Eina_Vpath path);
* *
* @param str the buffer to stuff the characters into * @param str the buffer to stuff the characters into
* @param size the size of the buffer * @param size the size of the buffer
* @param format A snprintf style format string, which will get evalulated after the vpath strings are getting replaced * @param format A snprintf style format string, which will get evaluated after the vpath strings are getting replaced
* @param ... The arguments for the format string * @param ... The arguments for the format string
* *
* @return the number of characters that are written into str, on a error a value < 0 is returned. * @return the number of characters that are written into str, on a error a value < 0 is returned.

View File

@ -32,7 +32,7 @@ mixin Efl.Ui.Dnd {
} }
} }
drop_target_add { drop_target_add {
[[Make the current object as drop targert. [[Make the current object as drop target.
There are four events emitted: There are four events emitted:
- EFL_UI_DND_EVENT_DRAG_ENTER - EFL_UI_DND_EVENT_DRAG_ENTER
- EFL_UI_DND_EVENT_DRAG_LEAVE - EFL_UI_DND_EVENT_DRAG_LEAVE

View File

@ -1895,10 +1895,10 @@ elm_widget_tree_unfocusable_get(const Eo *obj)
* *
* Get the list of focusable child objects. * Get the list of focusable child objects.
* *
* This function retruns list of child objects which can get focus. * This function returns list of child objects which can get focus.
* *
* @param obj The parent widget * @param obj The parent widget
* @retrun list of focusable child objects. * @return list of focusable child objects.
* *
* @ingroup Widget * @ingroup Widget
*/ */

View File

@ -202,7 +202,7 @@ struct _Efl_Ui_Win_Data
int *rots; /* indicates available rotations */ int *rots; /* indicates available rotations */
unsigned int count; /* number of elements in available rotations */ unsigned int count; /* number of elements in available rotations */
Eina_Bool wm_supported : 1; /* set true when the window manager support window rotation */ Eina_Bool wm_supported : 1; /* set true when the window manager support window rotation */
Eina_Bool use : 1; /* set ture when application use window manager rotation. */ Eina_Bool use : 1; /* set true when application use window manager rotation. */
} wm_rot; } wm_rot;
void *trap_data; void *trap_data;

View File

@ -186,7 +186,7 @@ EAPI void elm_config_profile_save(const char *profile);
* @p derive_options string. * @p derive_options string.
* *
* At this point it is not expected that anyone would generally use this API * At this point it is not expected that anyone would generally use this API
* except if you are a destktop environment and so the user base of this API * except if you are a desktop environment and so the user base of this API
* will be enlightenment itself. * will be enlightenment itself.
* *
* @param profile The new profile's name * @param profile The new profile's name
@ -207,7 +207,7 @@ EAPI void elm_config_profile_derived_add(const char *profile, const char
* from the current profile. * from the current profile.
* *
* At this point it is not expected that anyone would generally use this API * At this point it is not expected that anyone would generally use this API
* except if you are a destktop environment and so the user base of this API * except if you are a desktop environment and so the user base of this API
* will be enlightenment itself. * will be enlightenment itself.
* *
* @param profile The profile's name that is to be deleted * @param profile The profile's name that is to be deleted
@ -968,7 +968,7 @@ EAPI double elm_config_longpress_timeout_get(void);
/** /**
* Set the duration for occurring long press event. * Set the duration for occurring long press event.
* *
* @param lonpress_timeout Timeout for long press event * @param longpress_timeout Timeout for long press event
* @ingroup Longpress * @ingroup Longpress
*/ */
EAPI void elm_config_longpress_timeout_set(double longpress_timeout); EAPI void elm_config_longpress_timeout_set(double longpress_timeout);
@ -981,7 +981,7 @@ EAPI void elm_config_longpress_timeout_set(double longpress_timeout);
* canvas windows in the event the native display system does not provide one * canvas windows in the event the native display system does not provide one
* or the native one is not wanted. * or the native one is not wanted.
* *
* @param lonpress_timeout Timeout for long press event * @param longpress_timeout Timeout for long press event
* @ingroup Softcursor * @ingroup Softcursor
* *
* @see elm_config_softcursor_mode_get() * @see elm_config_softcursor_mode_get()

View File

@ -299,7 +299,7 @@ _transit_del(Elm_Transit *transit)
free(transit); free(transit);
} }
//If the transit is deleted then EINA_FALSE is retruned. //If the transit is deleted then EINA_FALSE is returned.
static Eina_Bool static Eina_Bool
_transit_animate_op(Elm_Transit *transit, double progress) _transit_animate_op(Elm_Transit *transit, double progress)
{ {

View File

@ -290,7 +290,7 @@ EAPI void elm_win_norender_push(Evas_Object *obj);
EAPI void elm_win_norender_pop(Evas_Object *obj); EAPI void elm_win_norender_pop(Evas_Object *obj);
/** /**
* The retruns how many times norender has been pushed on the window * The returns how many times norender has been pushed on the window
* @param obj The window object * @param obj The window object
* @return The number of times norender has been pushed * @return The number of times norender has been pushed
* *

View File

@ -1212,7 +1212,7 @@ elocation_address_free(Elocation_Address *address_shadow)
} }
} }
/* Public API funtion to initialize the elocation library */ /* Public API function to initialize the elocation library */
EAPI Eina_Bool EAPI Eina_Bool
elocation_init(void) elocation_init(void)
{ {

View File

@ -487,9 +487,9 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx.Entity, Efl.Gfx.Color, Efl.Gfx.S
return: bool @warn_unused; [[$true if the call succeeded, $false otherwise.]] return: bool @warn_unused; [[$true if the call succeeded, $false otherwise.]]
params { params {
@in keyname: string @nonull; [[The key to request events for.]] @in keyname: string @nonull; [[The key to request events for.]]
@in modifiers: Efl.Input.Modifier; [[A combinaison of modifier @in modifiers: Efl.Input.Modifier; [[A combination of modifier
keys that must be present to trigger the event.]] keys that must be present to trigger the event.]]
@in not_modifiers: Efl.Input.Modifier; [[A combinaison of modifier @in not_modifiers: Efl.Input.Modifier; [[A combination of modifier
keys that must not be present to trigger the event.]] keys that must not be present to trigger the event.]]
@in exclusive: bool; [[Request that the $obj is the only object @in exclusive: bool; [[Request that the $obj is the only object
receiving the $keyname events.]] receiving the $keyname events.]]

View File

@ -61,7 +61,7 @@ if (recved < 0) {
} }
/* Start up / continue the parser. /* Start up / continue the parser.
* Note we pass recved==0 to signal that EOF has been recieved. * Note we pass recved==0 to signal that EOF has been received.
*/ */
nparsed = http_parser_execute(parser, &settings, buf, recved); nparsed = http_parser_execute(parser, &settings, buf, recved);

View File

@ -153,7 +153,7 @@ EFL_START_TEST(ecore_test_ecore_thread_eina_thread_queue_t2)
mcount = msgs; mcount = msgs;
if (mcount < 1000) if (mcount < 1000)
{ {
ck_abort_msg("ERR: not enough messages recieved -> %i\n", mcount); ck_abort_msg("ERR: not enough messages received -> %i\n", mcount);
} }
if (DEBUG) printf("%i messages sent\n", i); if (DEBUG) printf("%i messages sent\n", i);
ecore_thread_wait(th, 0.1); ecore_thread_wait(th, 0.1);

View File

@ -4065,7 +4065,7 @@ EFL_START_TEST(evas_textblock_obstacle)
"This is an example text to demonstrate the textblock object" "This is an example text to demonstrate the textblock object"
" with obstacle objects support." " with obstacle objects support."
" Any evas object <item size=72x16></item>can register itself as an obstacle to the textblock" " Any evas object <item size=72x16></item>can register itself as an obstacle to the textblock"
" object. Upon registring, it affects the layout of the text in" " object. Upon registering, it affects the layout of the text in"
" certain situations. Usually, when the obstacle shows above the text" " certain situations. Usually, when the obstacle shows above the text"
" area, it will cause the layout of the text to split and move" " area, it will cause the layout of the text to split and move"
" parts of it, so that all text area is apparent."; " parts of it, so that all text area is apparent.";