summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorJihoon Kim <jihoon48.kim@samsung.com>2014-01-07 14:28:45 +0900
committerJihoon Kim <jihoon48.kim@samsung.com>2014-01-07 14:28:45 +0900
commitcb9dedd44dd3f89a169b3d35da72c758d31fc961 (patch)
treed8e324c97fe143bc9bb4ee2462e5566b7c18acf7 /src/lib
parent946a797e0d9675ff7cd73f208f56189e79abb7ea (diff)
fix typos in EFL documents
Diffstat (limited to '')
-rw-r--r--src/lib/ecore_evas/Ecore_Evas.h2
-rw-r--r--src/lib/ecore_ipc/Ecore_Ipc.h4
-rw-r--r--src/lib/ephysics/EPhysics.h14
-rw-r--r--src/lib/evas/Evas_Common.h6
-rw-r--r--src/lib/evas/Evas_GL.h10
-rw-r--r--src/lib/evas/Evas_Legacy.h22
6 files changed, 29 insertions, 29 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index 45ea7db56d..3625316549 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -87,7 +87,7 @@ extern "C" {
87 */ 87 */
88 88
89/* these are dummy and just tell u what API levels ecore_evas supports - not if 89/* these are dummy and just tell u what API levels ecore_evas supports - not if
90 * the actual support is compiled in. you need to query for that separately. 90 * the actual support is compiled in. You need to query for that separately.
91 */ 91 */
92#define HAVE_ECORE_EVAS_X 1 92#define HAVE_ECORE_EVAS_X 1
93#define HAVE_ECORE_EVAS_FB 1 93#define HAVE_ECORE_EVAS_FB 1
diff --git a/src/lib/ecore_ipc/Ecore_Ipc.h b/src/lib/ecore_ipc/Ecore_Ipc.h
index 4679b4a87b..71cfa17ed9 100644
--- a/src/lib/ecore_ipc/Ecore_Ipc.h
+++ b/src/lib/ecore_ipc/Ecore_Ipc.h
@@ -163,7 +163,7 @@ EAPI unsigned long long _ecore_ipc_swap_64(unsigned long long v) EINA_DEPRECATED
163 ptr = d; 163 ptr = d;
164/* footer for the hell of it */ 164/* footer for the hell of it */
165#define ECORE_IPC_DEC_STRUCT_FOOT() return 1 165#define ECORE_IPC_DEC_STRUCT_FOOT() return 1
166/* header for encoder - gives native strct type and size of flattened packet */ 166/* header for encoder - gives native struct type and size of flattened packet */
167#define ECORE_IPC_ENC_STRUCT_HEAD(typ, sz) \ 167#define ECORE_IPC_ENC_STRUCT_HEAD(typ, sz) \
168 typ *p; \ 168 typ *p; \
169 unsigned char *d, *ptr; \ 169 unsigned char *d, *ptr; \
@@ -319,7 +319,7 @@ EAPI void ecore_ipc_client_flush(Ecore_Ipc_Client *cl);
319 319
320EAPI int ecore_ipc_ssl_available_get(void); 320EAPI int ecore_ipc_ssl_available_get(void);
321/* FIXME: need to add a callback to "ok" large ipc messages greater than */ 321/* FIXME: need to add a callback to "ok" large ipc messages greater than */
322/* a certain size (seurity/DOS attack safety) */ 322/* a certain size (security/DOS attack safety) */
323 323
324#ifdef __cplusplus 324#ifdef __cplusplus
325} 325}
diff --git a/src/lib/ephysics/EPhysics.h b/src/lib/ephysics/EPhysics.h
index f3716f9d00..e7c7743f60 100644
--- a/src/lib/ephysics/EPhysics.h
+++ b/src/lib/ephysics/EPhysics.h
@@ -513,7 +513,7 @@ typedef struct _EPhysics_Shape EPhysics_Shape;
513 * The returned shape initially doesn't has points set, so it's required 513 * The returned shape initially doesn't has points set, so it's required
514 * to set vertices with @ref ephysics_shape_point_add(). 514 * to set vertices with @ref ephysics_shape_point_add().
515 * 515 *
516 * After the shape is completelly defined, all the points were added, 516 * After the shape is completely defined, all the points were added,
517 * it's possible to create one or more bodies with 517 * it's possible to create one or more bodies with
518 * @ref ephysics_body_shape_add(). 518 * @ref ephysics_body_shape_add().
519 * 519 *
@@ -1048,7 +1048,7 @@ EAPI void ephysics_world_render_geometry_get(const EPhysics_World *world, Evas_C
1048 * 1048 *
1049 * Save the dynamics world to a binary dump, a .bullet file. 1049 * Save the dynamics world to a binary dump, a .bullet file.
1050 * 1050 *
1051 * @note Should be used only for debugging purporses. 1051 * @note Should be used only for debugging purposes.
1052 * 1052 *
1053 * @param world the world to be serialized. 1053 * @param world the world to be serialized.
1054 * @param path where the serialized world should be written to. 1054 * @param path where the serialized world should be written to.
@@ -1079,7 +1079,7 @@ EAPI void ephysics_world_del(EPhysics_World *world);
1079 * 1079 *
1080 * A world can be played / paused. When running, it will simulate the 1080 * A world can be played / paused. When running, it will simulate the
1081 * physics step by step. When paused, it will stop simulation. Consequently 1081 * physics step by step. When paused, it will stop simulation. Consequently
1082 * all the registered callbacks won't be called since no event will ocurr 1082 * all the registered callbacks won't be called since no event will occur
1083 * (no collisions, no object updates). 1083 * (no collisions, no object updates).
1084 * 1084 *
1085 * When a world is created it starts running. 1085 * When a world is created it starts running.
@@ -1705,7 +1705,7 @@ EAPI Eina_Bool ephysics_world_bodies_outside_back_autodel_get(const EPhysics_Wor
1705 * Also, keep in mind 1705 * Also, keep in mind
1706 * that if you're using CPU intense calculations maybe this framerate won't 1706 * that if you're using CPU intense calculations maybe this framerate won't
1707 * be achieved, so the time step will be bigger. You need to define 1707 * be achieved, so the time step will be bigger. You need to define
1708 * what range of frames per secons you need to support and configure 1708 * what range of frames per seconds you need to support and configure
1709 * @p max_sub_steps and @p fixed_time_step according to this. 1709 * @p max_sub_steps and @p fixed_time_step according to this.
1710 * 1710 *
1711 * By decreasing the size of @p fixed_time_step, you are increasing the 1711 * By decreasing the size of @p fixed_time_step, you are increasing the
@@ -1981,7 +1981,7 @@ EAPI Eina_Bool ephysics_world_stack_enable_get(const EPhysics_World *world);
1981 * @li or @ref ephysics_body_shape_add(). 1981 * @li or @ref ephysics_body_shape_add().
1982 * 1982 *
1983 * Also they can be soft bodies, that won't act as rigid bodies. They will 1983 * Also they can be soft bodies, that won't act as rigid bodies. They will
1984 * deform its shape under certain circunstances, like under collisions. 1984 * deform its shape under certain circumstances, like under collisions.
1985 * Soft bodies can be created with: 1985 * Soft bodies can be created with:
1986 * @li @ref ephysics_body_soft_cylinder_add(); 1986 * @li @ref ephysics_body_soft_cylinder_add();
1987 * @li @ref ephysics_body_soft_box_add(); 1987 * @li @ref ephysics_body_soft_box_add();
@@ -2011,7 +2011,7 @@ EAPI Eina_Bool ephysics_world_stack_enable_get(const EPhysics_World *world);
2011 * be affected by gravity. 2011 * be affected by gravity.
2012 * 2012 *
2013 * Forces will be acting while they're set, changing bodies velocity over time. 2013 * Forces will be acting while they're set, changing bodies velocity over time.
2014 * Impulses are applied only once, modifying bodies velocity imediatelly to the 2014 * Impulses are applied only once, modifying bodies velocity immediately to the
2015 * new value. 2015 * new value.
2016 * 2016 *
2017 * Forces can be managed with: 2017 * Forces can be managed with:
@@ -2194,7 +2194,7 @@ typedef enum _EPhysics_Body_Cloth_Anchor_Side
2194 * @enum _EPhysics_Body_Face 2194 * @enum _EPhysics_Body_Face
2195 * @typedef EPhysics_Body_Face 2195 * @typedef EPhysics_Body_Face
2196 * 2196 *
2197 * Define in wich body's face the evas object should be set. 2197 * Define in which body's face the evas object should be set.
2198 * 2198 *
2199 * @see ephysics_body_face_evas_object_set() 2199 * @see ephysics_body_face_evas_object_set()
2200 * @see ephysics_body_face_evas_object_unset() 2200 * @see ephysics_body_face_evas_object_unset()
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h
index 04077864f9..d4c83c3577 100644
--- a/src/lib/evas/Evas_Common.h
+++ b/src/lib/evas/Evas_Common.h
@@ -150,7 +150,7 @@ typedef enum _Evas_Button_Flags
150typedef enum _Evas_Event_Flags 150typedef enum _Evas_Event_Flags
151{ 151{
152 EVAS_EVENT_FLAG_NONE = 0, /**< No fancy flags set */ 152 EVAS_EVENT_FLAG_NONE = 0, /**< No fancy flags set */
153 EVAS_EVENT_FLAG_ON_HOLD = (1 << 0), /**< This event is being delivered but should be put "on hold" until the on hold flag is unset. the event should be used for informational purposes and maybe some indications visually, but not actually perform anything */ 153 EVAS_EVENT_FLAG_ON_HOLD = (1 << 0), /**< This event is being delivered but should be put "on hold" until the on hold flag is unset. The event should be used for informational purposes and maybe some indications visually, but not actually perform anything */
154 EVAS_EVENT_FLAG_ON_SCROLL = (1 << 1) /**< This event flag indicates the event occurs while scrolling; for example, DOWN event occurs during scrolling; the event should be used for informational purposes and maybe some indications visually, but not actually perform anything */ 154 EVAS_EVENT_FLAG_ON_SCROLL = (1 << 1) /**< This event flag indicates the event occurs while scrolling; for example, DOWN event occurs during scrolling; the event should be used for informational purposes and maybe some indications visually, but not actually perform anything */
155} Evas_Event_Flags; /**< Flags for Events */ 155} Evas_Event_Flags; /**< Flags for Events */
156 156
@@ -378,7 +378,7 @@ typedef enum _Evas_Aspect_Control
378typedef enum _Evas_Display_Mode 378typedef enum _Evas_Display_Mode
379{ 379{
380 EVAS_DISPLAY_MODE_NONE = 0, /**<Default mode */ 380 EVAS_DISPLAY_MODE_NONE = 0, /**<Default mode */
381 EVAS_DISPLAY_MODE_COMPRESS = 1, /**< Use this mode when you want to give comppress display mode hint to an object */ 381 EVAS_DISPLAY_MODE_COMPRESS = 1, /**< Use this mode when you want to give compress display mode hint to an object */
382 EVAS_DISPLAY_MODE_EXPAND = 2, /**< Use this mode when you want to give expand display mode hint to an object */ 382 EVAS_DISPLAY_MODE_EXPAND = 2, /**< Use this mode when you want to give expand display mode hint to an object */
383 EVAS_DISPLAY_MODE_DONT_CHANGE = 3 /**< Use this mode when an object should not change its display mode */ 383 EVAS_DISPLAY_MODE_DONT_CHANGE = 3 /**< Use this mode when an object should not change its display mode */
384} Evas_Display_Mode; /**< object's display mode type related with compress/expand or etc mode */ 384} Evas_Display_Mode; /**< object's display mode type related with compress/expand or etc mode */
@@ -3710,7 +3710,7 @@ EAPI Eina_Bool evas_textblock_cursor_eol_get(cons
3710/** 3710/**
3711 * @typedef Evas_Textgrid_Palette 3711 * @typedef Evas_Textgrid_Palette
3712 * 3712 *
3713 * The palette to use for the forgraound and background colors. 3713 * The palette to use for the foreground and background colors.
3714 * 3714 *
3715 * @since 1.7 3715 * @since 1.7
3716 */ 3716 */
diff --git a/src/lib/evas/Evas_GL.h b/src/lib/evas/Evas_GL.h
index 54bb1c0c9c..db3a1c6633 100644
--- a/src/lib/evas/Evas_GL.h
+++ b/src/lib/evas/Evas_GL.h
@@ -15,7 +15,7 @@ extern "C" {
15 * to use OpenGL to render to specially set up image objects (which act as 15 * to use OpenGL to render to specially set up image objects (which act as
16 * render target surfaces). 16 * render target surfaces).
17 * 17 *
18 * Below is an illlustrative example of how to use OpenGL to render to an 18 * Below is an illustrative example of how to use OpenGL to render to an
19 * object in Evas. 19 * object in Evas.
20 * 20 *
21 * @code 21 * @code
@@ -91,14 +91,14 @@ main(int argc, char **argv)
91 91
92 // set up the image object. a filled one by default 92 // set up the image object. a filled one by default
93 r1 = evas_object_image_filled_add(canvas); 93 r1 = evas_object_image_filled_add(canvas);
94 // attach important data we need to the object using key names. this just 94 // attach important data we need to the object using key names. This just
95 // avoids some global variables and means we can do nice cleanup. you can 95 // avoids some global variables and means we can do nice cleanup. You can
96 // avoid this if you are lazy 96 // avoid this if you are lazy
97 evas_object_data_set(r1, "..gld", gld); 97 evas_object_data_set(r1, "..gld", gld);
98 // when the object is deleted - call the on_del callback. like the above, 98 // when the object is deleted - call the on_del callback. like the above,
99 // this is just being clean 99 // this is just being clean
100 evas_object_event_callback_add(r1, EVAS_CALLBACK_DEL, on_del, NULL); 100 evas_object_event_callback_add(r1, EVAS_CALLBACK_DEL, on_del, NULL);
101 // set up an actual pixel size fot the buffer data. it may be different 101 // set up an actual pixel size fot the buffer data. It may be different
102 // to the output size. any windowing system has something like this, just 102 // to the output size. any windowing system has something like this, just
103 // evas has 2 sizes, a pixel size and the output object size 103 // evas has 2 sizes, a pixel size and the output object size
104 evas_object_image_size_set(r1, w, h); 104 evas_object_image_size_set(r1, w, h);
@@ -462,7 +462,7 @@ struct _Evas_GL_Config
462 * Creates a new Evas_GL object and returns a handle for gl rendering on efl. 462 * Creates a new Evas_GL object and returns a handle for gl rendering on efl.
463 * 463 *
464 * @param e The given evas canvas OpenGL is to be used on. 464 * @param e The given evas canvas OpenGL is to be used on.
465 * @return The created evas_gl object, or NULl on fasilure. 465 * @return The created evas_gl object, or NULL on failure.
466 */ 466 */
467EAPI Evas_GL *evas_gl_new (Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); 467EAPI Evas_GL *evas_gl_new (Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
468 468
diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h
index 7aa76a2787..f5d3443d36 100644
--- a/src/lib/evas/Evas_Legacy.h
+++ b/src/lib/evas/Evas_Legacy.h
@@ -966,7 +966,7 @@ EAPI void evas_post_event_callback_remove_full(Evas *e, Evas_Object_Event_Post_
966EAPI void evas_event_default_flags_set(Evas *e, Evas_Event_Flags flags) EINA_ARG_NONNULL(1); 966EAPI void evas_event_default_flags_set(Evas *e, Evas_Event_Flags flags) EINA_ARG_NONNULL(1);
967 967
968/** 968/**
969 * Get the defaulty set of flags an event begins with 969 * Get the default set of flags an event begins with
970 * 970 *
971 * @param e The canvas to get the default event flags from 971 * @param e The canvas to get the default event flags from
972 * @return The default event flags for that canvas 972 * @return The default event flags for that canvas
@@ -1345,7 +1345,7 @@ EAPI int evas_image_cache_get(const Evas *e) EINA_WARN_UNUSED_RESULT EINA_
1345 * Get the maximum image size evas can possibly handle 1345 * Get the maximum image size evas can possibly handle
1346 * 1346 *
1347 * @param e The given evas pointer. 1347 * @param e The given evas pointer.
1348 * @param maxw Pointer to hold the return value in pixels of the maxumum width 1348 * @param maxw Pointer to hold the return value in pixels of the maximum width
1349 * @param maxh Pointer to hold the return value in pixels of the maximum height 1349 * @param maxh Pointer to hold the return value in pixels of the maximum height
1350 * 1350 *
1351 * This function returns the larges image or surface size that evas can handle 1351 * This function returns the larges image or surface size that evas can handle
@@ -2818,7 +2818,7 @@ EAPI const Evas_Map *evas_object_map_get(const Evas_Object *obj);
2818 * @param w Pointer to an integer in which to store the minimum width. 2818 * @param w Pointer to an integer in which to store the minimum width.
2819 * @param h Pointer to an integer in which to store the minimum height. 2819 * @param h Pointer to an integer in which to store the minimum height.
2820 * 2820 *
2821 * These are hints on the minimim sizes @p obj should have. This is 2821 * These are hints on the minimum sizes @p obj should have. This is
2822 * not a size enforcement in any way, it's just a hint that should be 2822 * not a size enforcement in any way, it's just a hint that should be
2823 * used whenever appropriate. 2823 * used whenever appropriate.
2824 * 2824 *
@@ -5321,7 +5321,7 @@ EAPI Evas_Coord evas_object_text_inset_get(const Evas_Object *obj) EIN
5321/** 5321/**
5322 * Retrieve position and dimension information of a character within a text @c Evas_Object. 5322 * Retrieve position and dimension information of a character within a text @c Evas_Object.
5323 * 5323 *
5324 * This function is used to obtain the X, Y, width and height of a the character 5324 * This function is used to obtain the X, Y, width and height of the character
5325 * located at @p pos within the @c Evas_Object @p obj. @p obj must be a text object 5325 * located at @p pos within the @c Evas_Object @p obj. @p obj must be a text object
5326 * as created with evas_object_text_add(). Any of the @c Evas_Coord parameters (@p cx, 5326 * as created with evas_object_text_add(). Any of the @c Evas_Coord parameters (@p cx,
5327 * @p cy, @p cw, @p ch) may be @c NULL in which case no value will be assigned to that 5327 * @p cy, @p cw, @p ch) may be @c NULL in which case no value will be assigned to that
@@ -5341,7 +5341,7 @@ EAPI int evas_object_text_char_coords_get(const Evas_Object *ob
5341 5341
5342/** 5342/**
5343 * Returns the logical position of the last char in the text 5343 * Returns the logical position of the last char in the text
5344 * up to the pos given. this is NOT the position of the last char 5344 * up to the pos given. This is NOT the position of the last char
5345 * because of the possibility of RTL in the text. 5345 * because of the possibility of RTL in the text.
5346 */ 5346 */
5347EAPI int evas_object_text_last_up_to_pos(const Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1); 5347EAPI int evas_object_text_last_up_to_pos(const Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
@@ -6057,7 +6057,7 @@ EAPI void evas_object_textgrid_cell_size_get(const Evas_Object *obj, Evas_Coord
6057 * 6057 *
6058 * @param obj The textgrid object to query for font information. 6058 * @param obj The textgrid object to query for font information.
6059 * @param pal The type of the palette to set the color. 6059 * @param pal The type of the palette to set the color.
6060 * @param idx The index of the paletter to wich the color is stored. 6060 * @param idx The index of the paletter to which the color is stored.
6061 * @param r The red component of the color. 6061 * @param r The red component of the color.
6062 * @param g The green component of the color. 6062 * @param g The green component of the color.
6063 * @param b The blue component of the color. 6063 * @param b The blue component of the color.
@@ -6085,7 +6085,7 @@ EAPI void evas_object_textgrid_palette_set(Evas_Object *obj, Evas_Textgrid_Palet
6085 * 6085 *
6086 * @param obj The textgrid object to query for font information. 6086 * @param obj The textgrid object to query for font information.
6087 * @param pal The type of the palette to set the color. 6087 * @param pal The type of the palette to set the color.
6088 * @param idx The index of the paletter to wich the color is stored. 6088 * @param idx The index of the palette to which the color is stored.
6089 * @param r A pointer to the red component of the color. 6089 * @param r A pointer to the red component of the color.
6090 * @param g A pointer to the green component of the color. 6090 * @param g A pointer to the green component of the color.
6091 * @param b A pointer to the blue component of the color. 6091 * @param b A pointer to the blue component of the color.
@@ -6966,7 +6966,7 @@ EAPI Evas_Object *evas_object_box_add_to(Evas_Object *parent) EINA
6966 * widths as to fit the remaining space. The @c weight_x property, 6966 * widths as to fit the remaining space. The @c weight_x property,
6967 * besides telling the element is resizable, gives a @b weight for the 6967 * besides telling the element is resizable, gives a @b weight for the
6968 * resizing process. The parent box will try to distribute (or take 6968 * resizing process. The parent box will try to distribute (or take
6969 * off) widths accordingly to the @b normalized list of weigths: most 6969 * off) widths accordingly to the @b normalized list of weights: most
6970 * weighted children remain/get larger in this process than the least 6970 * weighted children remain/get larger in this process than the least
6971 * ones. @c weight_y does not influence the layout. 6971 * ones. @c weight_y does not influence the layout.
6972 * 6972 *
@@ -7016,7 +7016,7 @@ EAPI void evas_object_box_layout_homogeneous_vertical(Evas
7016 * \par Box's properties: 7016 * \par Box's properties:
7017 * @c align_h has no influence on the box for this layout. 7017 * @c align_h has no influence on the box for this layout.
7018 * @c padding_h tells the box to draw empty spaces of that size, in 7018 * @c padding_h tells the box to draw empty spaces of that size, in
7019 * pixels, between the (equal) child objects's cells. The @c align_v 7019 * pixels, between the (equal) child objects' cells. The @c align_v
7020 * and @c padding_v properties of the box don't contribute to its 7020 * and @c padding_v properties of the box don't contribute to its
7021 * behaviour when this layout is chosen. 7021 * behaviour when this layout is chosen.
7022 * 7022 *
@@ -7057,7 +7057,7 @@ EAPI void evas_object_box_layout_homogeneous_horizontal(Ev
7057 * 7057 *
7058 * \par Box's properties: 7058 * \par Box's properties:
7059 * @c padding_h tells the box to draw empty spaces of that size, in 7059 * @c padding_h tells the box to draw empty spaces of that size, in
7060 * pixels, between the child objects's cells. @c align_h controls the 7060 * pixels, between the child objects' cells. @c align_h controls the
7061 * horizontal alignment of the child objects, relative to the 7061 * horizontal alignment of the child objects, relative to the
7062 * containing box. When set to @c 0.0, children are aligned to the 7062 * containing box. When set to @c 0.0, children are aligned to the
7063 * left. A value of @c 1.0 lets them aligned to the right 7063 * left. A value of @c 1.0 lets them aligned to the right
@@ -7116,7 +7116,7 @@ EAPI void evas_object_box_layout_homogeneous_max_size_vert
7116 * 7116 *
7117 * \par Box's properties: 7117 * \par Box's properties:
7118 * @c padding_h tells the box to draw empty spaces of that size, in 7118 * @c padding_h tells the box to draw empty spaces of that size, in
7119 * pixels, between the child objects's cells. @c align_h dictates the 7119 * pixels, between the child objects' cells. @c align_h dictates the
7120 * horizontal alignment of the rows (@c 0.0 to left align them, @c 1.0 7120 * horizontal alignment of the rows (@c 0.0 to left align them, @c 1.0
7121 * to right align). A value of @c -1.0 to @c align_h lets the rows 7121 * to right align). A value of @c -1.0 to @c align_h lets the rows
7122 * @b justified horizontally. @c align_v controls the vertical alignment 7122 * @b justified horizontally. @c align_v controls the vertical alignment