enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 3 Projects Releases Wiki Activity

docs: Fix typos and some wrong expressions in API reference doc. 

Summary: I had fixed some typos and some wrong expressions in API reference doc

Test Plan: N/A

Reviewers: raster, zmike, Hermet, segfaultxavi

Reviewed By: Hermet

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D6943
This commit is contained in:
Myoungwoon Roy, Kim 2018-08-30 14:01:21 +09:00 committed by Hermet Park
parent 5b9d152e14
commit e06a9b6acf
24 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/lib/ecore/efl_io_copier.eo
View File

@ -4,7 +4,7 @@ class Efl.Io.Copier (Efl.Loop_Consumer, Efl.Io.Closer) {
[[Copy from an @Efl.Io.Reader source to @Efl.Io.Writer destination.
During usage it will keep reference to @.source and
@.destination objects, automatically relasing them on
@.destination objects, automatically releasing them on
destruction.
By default the read-write process is done based on fixed-size

2
src/lib/ecore/efl_loop.eo
View File

@ -63,7 +63,7 @@ class Efl.Loop (Efl.Task)
set {}
get {}
values {
timepoint: double; [[Time in seconds since process specfic start point]]
timepoint: double; [[Time in seconds since process specific start point]]
}
}
idle {

2
src/lib/ecore/efl_loop_handler.eo
View File

@ -24,7 +24,7 @@ class Efl.Loop_Handler (Efl.Object)
}
}
@property fd {
[[ Controls a file desciptor to listen to for I/O, which points
[[ Controls a file descriptor to listen to for I/O, which points
to a data pipe such as a device, socket or pipe etc. ]]
set { }
get { }

2
src/lib/ecore_buffer/Ecore_Buffer_Queue.h
View File

@ -115,7 +115,7 @@ typedef void (*Ecore_Buffer_Consumer_Provider_Add_Cb) (Ecore_Buffer_Consumer *co
/**
* @typedef Ecore_Buffer_Consumer_Provider_Del_Cb
*
* @brief Called whenever a Ecore_Buffer_Provider disonnected.
* @brief Called whenever a Ecore_Buffer_Provider disconnected.
*
* @since 1.15
*

12
src/lib/ecore_con/Ecore_Con.h
View File

@ -1158,14 +1158,14 @@ EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs);
* applications that want to connect to that path without replicating
* its logic.
*
* @li If @a type is @c ECORE_CON_LOCAL_USER, the server will conect to
* @li If @a type is @c ECORE_CON_LOCAL_USER, the server will connect to
* the Unix socket. The path to the socket is taken from XDG_RUNTIME_DIR,
* if that is not set, then from HOME, even if this is not set, then from
* TMPDIR. If none is set, then path would be /tmp. From this path the
* function would connect to socket at "[path]/.ecore/[name]/[port]". If
* port is negetive, then to socket at "[path]/.ecore/[name]".
* port is negative, then to socket at "[path]/.ecore/[name]".
* @li If @a type is @c ECORE_CON_LOCAL_SYSTEM, the server will connect to
* Unix socket at "/tmp/.ecore_service|[name]|[port]". If port is negetive,
* Unix socket at "/tmp/.ecore_service|[name]|[port]". If port is negative,
* then to Unix socket at "/tmp/.ecore_service|[name]".
*
* @param is_system If #EINA_TRUE, will be a system wide socket
@ -1205,10 +1205,10 @@ EAPI char *ecore_con_local_path_new(Eina_Bool is_system, const char *name, int p
* the Unix socket. The path to the socket is taken from XDG_RUNTIME_DIR,
* if that is not set, then from HOME, even if this is not set, then from
* TMPDIR. If none is set, then path would be /tmp. From this path socket
* would be created as "[path]/.ecore/[name]/[port]". If port is negetive,
* would be created as "[path]/.ecore/[name]/[port]". If port is negative,
* then "[path]/.ecore/[name]".
* @li If @a type is @c ECORE_CON_LOCAL_SYSTEM, the server will listen
* on Unix socket "/tmp/.ecore_service|[name]|[port]". If port is negetive,
* on Unix socket "/tmp/.ecore_service|[name]|[port]". If port is negative,
* then "/tmp/.ecore_service|[name]".
* @li If @a type is @c ECORE_CON_LOCAL_ABSTRACT, then port number is not
* considered while creating the socket.
@ -2300,7 +2300,7 @@ EAPI int ecore_con_url_ssl_ca_set(Ecore_Con_Url *url_con,
* If not specified, libcurl will default to using port 1080 for proxies.
*
* @param url_con Connection object that will use the proxy.
* @param proxy Porxy string or @c NULL to disable
* @param proxy Proxy string or @c NULL to disable
*
* @return @c EINA_TRUE on success, @c EINA_FALSE on error.
* @since 1.2

2
src/lib/ecore_con/efl_net_server.eo
View File

@ -89,7 +89,7 @@ interface Efl.Net.Server {
Whenever changed, this property will only apply to new
connections, that is, if the current connection count
alredy exceeds the limit, no connections will be closed.
already exceeds the limit, no connections will be closed.
]]
values {
limit: uint; [[Number of allowed client connections]]

8
src/lib/ecore_evas/Ecore_Evas.h
View File

@ -1014,7 +1014,7 @@ EAPI void ecore_evas_msg_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *
* @brief Sets a callback for parent Ecore_Evas message.
*
* @param ee The Ecore_Evas to set callbacks on
* @param func_parent_handle The handle to be called when message arive.
* @param func_parent_handle The handle to be called when message arrive.
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
@ -1029,7 +1029,7 @@ EAPI void ecore_evas_callback_msg_parent_handle_set(Ecore_Evas *ee, void (*func_
* @brief Sets a callback for child Ecore_Evas message.
*
* @param ee The Ecore_Evas to set callbacks on
* @param func_handle The handle to be called when message arive
* @param func_handle The handle to be called when message arrive
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
@ -3078,8 +3078,8 @@ EAPI void ecore_evas_x11_shape_input_rectangle_set(Ecore_Evas *ee, int
* @param ee The Ecore_Evas
* @param x The X coordinate of the rectangular area to add.
* @param y The Y coordinate of the rectangular area to add.
* @param w The width of the rectangluar area to add.
* @param h The height of the rectangluar area to add.
* @param w The width of the rectangular area to add.
* @param h The height of the rectangular area to add.
*
* Ecore_Evas may apply (orthogonal) rotations if needed, via an internal
* call to _ecore_evas_x11_convert_rectangle_with_angle(). Note that

8
src/lib/ecore_file/Ecore_File.h
View File

@ -195,7 +195,7 @@ EAPI Eina_Bool ecore_file_is_dir (const char *file);
*
* This function creates the directory @p dir, with the mode S_IRUSR |
* S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH on UNIX
* (mode is unsued on Windows). On success, it returns @c EINA_TRUE,
* (mode is unused on Windows). On success, it returns @c EINA_TRUE,
* @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ecore_file_mkdir (const char *dir);
@ -379,7 +379,7 @@ EAPI const char *ecore_file_file_get (const char *path);
* @param file The name of the file.
* @return The directory name.
*
* This function returns the directory where @p file resides as anewly
* This function returns the directory where @p file resides as newly
* allocated string. If @p file is @c NULL or on error, this function
* returns @c NULL. When not needed anymore, the returned value must
* be freed.
@ -537,7 +537,7 @@ EAPI Ecore_File_Monitor *ecore_file_monitor_add(const char *path,
* monitored by ecore_file_monitor_add(). @p em must be the value
* returned by ecore_file_monitor_add(). If @p em is @c NULL, or none
* of the notify methods (Inotify, Windows notification or polling) is
* availablethis function does nothing.
* available this function does nothing.
*/
EAPI void ecore_file_monitor_del(Ecore_File_Monitor *em);
@ -665,7 +665,7 @@ EAPI void ecore_file_download_abort_all(void);
/**
* @brief Aborts the given download job and call the completion_cb
* callbck with a status of 1 (error).
* callback with a status of 1 (error).
*
* @param job The download job to abort.
*

2
src/lib/edje/Edje.h
View File

@ -39,7 +39,7 @@ collection consists of a list of visual parts, as well as a list of
programs. A program is a conditionally run program that if a
particular event occurs (a button is pressed, a mouse enters or leaves
a part) will trigger an action that may affect other parts. In this
way a part collection can be "programmed" via its file as to hilight
way a part collection can be "programmed" via its file as to highlight
buttons when the mouse passes over them or show hidden parts when a
button is clicked somewhere etc. The actions performed in changing
from one state to another are also allowed to transition over a period

6
src/lib/edje/Edje_Common.h
View File

@ -1835,7 +1835,7 @@ typedef enum _Edje_Tween_Mode
EDJE_TWEEN_MODE_DECELERATE = 4, /**< Decelerate tween mode value */
EDJE_TWEEN_MODE_ACCELERATE_FACTOR = 5, /**< Accelerate factor tween mode value */
EDJE_TWEEN_MODE_DECELERATE_FACTOR = 6, /**< Decelerate factor tween mode value */
EDJE_TWEEN_MODE_SINUSOIDAL_FACTOR = 7, /**< Sinusoidal factgor tween mode value */
EDJE_TWEEN_MODE_SINUSOIDAL_FACTOR = 7, /**< Sinusoidal factor tween mode value */
EDJE_TWEEN_MODE_DIVISOR_INTERP = 8, /**< Divisor iterp tween mode value */
EDJE_TWEEN_MODE_BOUNCE = 9, /**< Bounce tween mode value */
EDJE_TWEEN_MODE_SPRING = 10, /**< Spring tween mode value */
@ -1863,7 +1863,7 @@ typedef enum _Edje_Action_Type
EDJE_ACTION_TYPE_SCRIPT = 7, /**< Script action value */
EDJE_ACTION_TYPE_FOCUS_SET = 8, /**< Focus set action value */
EDJE_ACTION_TYPE_RESERVED00 = 9, /**< Reversed do action value */
EDJE_ACTION_TYPE_FOCUS_OBJECT = 10, /**< Forcus object action value */
EDJE_ACTION_TYPE_FOCUS_OBJECT = 10, /**< Focus object action value */
EDJE_ACTION_TYPE_PARAM_COPY = 11, /**< Param copy action value */
EDJE_ACTION_TYPE_PARAM_SET = 12, /**< Param set action value */
EDJE_ACTION_TYPE_SOUND_SAMPLE = 13, /**< @since 1.1 @brief Sound sample action value */
@ -2027,7 +2027,7 @@ EAPI void edje_message_signal_process (void);
*
* @brief Functions to manipulate audio abilities in edje.
*
* Perspective is a graphical tool that makes objets represented in 2D
* Perspective is a graphical tool that makes objects represented in 2D
* look like they have a 3D appearance.
*
* Edje allows us to use perspective on any edje object. This group of

2
src/lib/edje/Edje_Edit.h
View File

@ -1105,7 +1105,7 @@ EAPI Eina_Bool edje_edit_color_class_del(Evas_Object *obj, const char *name);
/**
* @brief Gets all the colors that compose the class.
*
* You can pass NULL to colors you are not intrested in.
* You can pass NULL to colors you are not interested in.
*
* @param obj Object being edited.
* @param class_name Color class to fetch values.

2
src/lib/edje/Edje_Legacy.h
View File

@ -2969,7 +2969,7 @@ EAPI Eina_Bool edje_object_part_exists(const Evas_Object *obj, const char *part)
*
* @brief Functions that deal with 3D projection of an 2D object.
*
* Perspective is a graphical tool that makes objets represented in 2D
* Perspective is a graphical tool that makes objects represented in 2D
* look like they have a 3D appearance.
*
* Edje allows us to use perspective on any edje object. This group of

4
src/lib/eet/Eet.h
View File

@ -3376,7 +3376,7 @@ eet_data_descriptor_decode(Eet_Data_Descriptor *edd,
* @param size_ret pointer to the an int to be filled with the decoded size.
* @return NULL on failure, or a valid encoded data chunk on success.
*
* This function takes a data structutre in memory and encodes it into a
* This function takes a data structure in memory and encodes it into a
* serialised chunk of data that can be decoded again by
* eet_data_descriptor_decode(). This is useful for being able to transmit
* data structures across sockets, pipes, IPC or shared file mechanisms,
@ -4222,7 +4222,7 @@ eet_data_descriptor_decode_cipher(Eet_Data_Descriptor *edd,
* @param size_ret pointer to the an int to be filled with the decoded size.
* @return NULL on failure, or a valid encoded data chunk on success.
*
* This function takes a data structutre in memory and encodes it into a
* This function takes a data structure in memory and encodes it into a
* serialised chunk of data that can be decoded again by
* eet_data_descriptor_decode(). This is useful for being able to transmit
* data structures across sockets, pipes, IPC or shared file mechanisms,

2
src/lib/elementary/efl_access_object.eo
View File

@ -1,7 +1,7 @@
enum Efl.Access.Type
{
[[Type of accessibility object]]
regular, [[default accessibile object]]
regular, [[default accessible object]]
disabled, [[skip object and its children in accessibility hierarchy]]
skipped [[skip object in accessibility hierarchy]]
}

4
src/lib/elementary/efl_config_global.eo
View File

@ -77,7 +77,7 @@ class Efl.Config_Global (Efl.Object, Efl.Config)
encoded in the $options string.
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
this API except if you are a desktop environment and so the user
base of this API will be enlightenment itself.
@since 1.17
@ -95,7 +95,7 @@ class Efl.Config_Global (Efl.Object, Efl.Config)
derived from the current profile.
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
this API except if you are a desktop environment and so the user
base of this API will be enlightenment itself.
@since 1.17

4
src/lib/elementary/efl_ui_calendar.eo
View File

@ -8,7 +8,7 @@ enum Efl.Ui.Calendar_Weekday
]]
sunday, [[Sunday weekday]]
monday, [[Monday weekday]]
tuesday, [[Tusday weekday]]
tuesday, [[Tuesday weekday]]
wednesday, [[Wednesday weekday]]
thursday, [[Thursday weekday]]
friday, [[Friday weekday]]
@ -55,7 +55,7 @@ class Efl.Ui.Calendar (Efl.Ui.Layout.Object, Efl.Ui.Focus.Composition, Efl.Acces
]]
}
values {
min: Efl.Time; [[Time structure containing the minmum date.]]
min: Efl.Time; [[Time structure containing the minimum date.]]
}
}
@property date_max {

2
src/lib/elementary/efl_ui_focus_manager_sub.eo
View File

@ -1,6 +1,6 @@
mixin Efl.Ui.Focus.Manager_Sub (Efl.Interface, Efl.Ui.Focus.Manager, Efl.Object)
{
[[A class that automatically registeres its border elements in the parent manager
[[A class that automatically registers its border elements in the parent manager
This sub manager will register its border elements on the parent manager.
The parent manager is found with the @Efl.Ui.Focus.Object interface of the

2
src/lib/elementary/efl_ui_focus_object.eo
View File

@ -58,7 +58,7 @@ mixin Efl.Ui.Focus.Object
[[Tells the object that its children will be queried soon by the given manager.
The call will be a NOP if there is already a active preprare_logical call on this object
Deleting manager items in this call will result in undefied behaviour and may cause your system to crash.
Deleting manager items in this call will result in undefined behaviour and may cause your system to crash.
]]
}
prepare_logical_none_recursive @protected {

2
src/lib/elementary/efl_ui_popup_alert_text.eo
View File

@ -14,7 +14,7 @@ class Efl.Ui.Popup_Alert_Text(Efl.Ui.Popup_Alert, Efl.Text)
]]
}
values {
max_size: Eina.Size2D; [[A 2D max size in pixel uinits.]]
max_size: Eina.Size2D; [[A 2D max size in pixel units.]]
}
}
}

2
src/lib/elementary/efl_ui_spin_button_private.h
View File

@ -8,7 +8,7 @@ struct _Efl_Ui_Spin_Button_Data
Evas_Object *ent, *inc_button, *dec_button, *text_button;
Ecore_Timer *delay_change_timer; /**< a timer for a delay,changed smart callback */
Ecore_Timer *spin_timer; /**< a timer for a repeated spinner value change on mouse down */
Ecore_Timer *longpress_timer; /**< a timer to detect long press. After lonpress timeout,
Ecore_Timer *longpress_timer; /**< a timer to detect long press. After longress timeout,
start continuous change of values until mouse up */
Efl_Ui_Dir dir;

2
src/lib/elementary/efl_ui_widget.eo
View File

@ -545,7 +545,7 @@ abstract Efl.Ui.Widget (Efl.Canvas.Group, Efl.Access.Object,
@in current_state : Efl.Ui.Widget_Focus_State;
[[The focus manager to register with.]]
@inout configured_state : Efl.Ui.Widget_Focus_State;
[[The evalulated Focus state that should be used.]]
[[The evaluated Focus state that should be used.]]
@in redirect : Efl.Ui.Widget;
[[A redirect that will be set by the elm.widget implementation.]]
}

8
src/lib/elementary/efl_ui_win.eo
View File

@ -693,9 +693,9 @@ class Efl.Ui.Win (Efl.Ui.Widget, Efl.Canvas.Scene, Efl.Canvas.Pointer, Efl.Acces
return: bool; [[$true on success, $false otherwise]]
params {
@in key: string; [[This string is the keyname to grab.]]
@in modifiers: Efl.Input.Modifier; [[A combinaison of modifier keys
@in modifiers: Efl.Input.Modifier; [[A combination of modifier keys
that must be present to trigger the event. Not supported yet.]]
@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. Not supported yet.]]
@in priority: int; [[Not supported yet.]]
@in grab_mode: Efl.Ui.Win_Keygrab_Mode; [[Describes how the key should
@ -711,9 +711,9 @@ class Efl.Ui.Win (Efl.Ui.Widget, Efl.Canvas.Scene, Efl.Canvas.Pointer, Efl.Acces
return: bool; [[$true on success, $false otherwise]]
params {
@in key: string; [[This string is the keyname to grab.]]
@in modifiers: Efl.Input.Modifier; [[A combinaison of modifier keys
@in modifiers: Efl.Input.Modifier; [[A combination of modifier keys
that must be present to trigger the event. Not supported yet.]]
@in not_modifiers: Efl.Input.Modifier; [[A combinaison of modifier keys
@in not_modifiers: Efl.Input.Modifier; [[A combination of modifier keys
that must not be present to trigger the event. Not supported yet.]]
}
legacy: null;

4
src/lib/elementary/elm_access.h
View File

@ -258,9 +258,9 @@ EAPI void elm_access_action_cb_set(Evas_Object *obj, const Elm_Access_Action_Typ
* @brief Set the next access object for highlight.
* @since 1.8
*
* @param obj The object is previous access object of next for hilight.
* @param obj The object is previous access object of next for highlight.
* @param dir Access direction same as Focus direction
* @param next The object is next access object of obj for hilight.
* @param next The object is next access object of obj for highlight.
*
* Currently focus chain is used for access highlight chain. Use this API to
* customize highlight chain. If highlight chain is already established, you can

2
src/lib/elementary/elm_calendar.eo
View File

@ -32,7 +32,7 @@ enum Elm.Calendar.Weekday
legacy: elm_day;
sunday, [[Sunday weekday]]
monday, [[Monday weekday]]
tuesday, [[Tusday weekday]]
tuesday, [[Tuesday weekday]]
wednesday, [[Wednesday weekday]]
thursday, [[Thursday weekday]]
friday, [[Friday weekday]]