forked from enlightenment/efl
fix typos in EFL documents
This commit is contained in:
parent
946a797e0d
commit
cb9dedd44d
|
@ -87,7 +87,7 @@ extern "C" {
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* these are dummy and just tell u what API levels ecore_evas supports - not if
|
/* these are dummy and just tell u what API levels ecore_evas supports - not if
|
||||||
* the actual support is compiled in. you need to query for that separately.
|
* the actual support is compiled in. You need to query for that separately.
|
||||||
*/
|
*/
|
||||||
#define HAVE_ECORE_EVAS_X 1
|
#define HAVE_ECORE_EVAS_X 1
|
||||||
#define HAVE_ECORE_EVAS_FB 1
|
#define HAVE_ECORE_EVAS_FB 1
|
||||||
|
|
|
@ -163,7 +163,7 @@ EAPI unsigned long long _ecore_ipc_swap_64(unsigned long long v) EINA_DEPRECATED
|
||||||
ptr = d;
|
ptr = d;
|
||||||
/* footer for the hell of it */
|
/* footer for the hell of it */
|
||||||
#define ECORE_IPC_DEC_STRUCT_FOOT() return 1
|
#define ECORE_IPC_DEC_STRUCT_FOOT() return 1
|
||||||
/* header for encoder - gives native strct type and size of flattened packet */
|
/* header for encoder - gives native struct type and size of flattened packet */
|
||||||
#define ECORE_IPC_ENC_STRUCT_HEAD(typ, sz) \
|
#define ECORE_IPC_ENC_STRUCT_HEAD(typ, sz) \
|
||||||
typ *p; \
|
typ *p; \
|
||||||
unsigned char *d, *ptr; \
|
unsigned char *d, *ptr; \
|
||||||
|
@ -319,7 +319,7 @@ EAPI void ecore_ipc_client_flush(Ecore_Ipc_Client *cl);
|
||||||
|
|
||||||
EAPI int ecore_ipc_ssl_available_get(void);
|
EAPI int ecore_ipc_ssl_available_get(void);
|
||||||
/* FIXME: need to add a callback to "ok" large ipc messages greater than */
|
/* FIXME: need to add a callback to "ok" large ipc messages greater than */
|
||||||
/* a certain size (seurity/DOS attack safety) */
|
/* a certain size (security/DOS attack safety) */
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
}
|
}
|
||||||
|
|
|
@ -513,7 +513,7 @@ typedef struct _EPhysics_Shape EPhysics_Shape;
|
||||||
* The returned shape initially doesn't has points set, so it's required
|
* The returned shape initially doesn't has points set, so it's required
|
||||||
* to set vertices with @ref ephysics_shape_point_add().
|
* to set vertices with @ref ephysics_shape_point_add().
|
||||||
*
|
*
|
||||||
* After the shape is completelly defined, all the points were added,
|
* After the shape is completely defined, all the points were added,
|
||||||
* it's possible to create one or more bodies with
|
* it's possible to create one or more bodies with
|
||||||
* @ref ephysics_body_shape_add().
|
* @ref ephysics_body_shape_add().
|
||||||
*
|
*
|
||||||
|
@ -1048,7 +1048,7 @@ EAPI void ephysics_world_render_geometry_get(const EPhysics_World *world, Evas_C
|
||||||
*
|
*
|
||||||
* Save the dynamics world to a binary dump, a .bullet file.
|
* Save the dynamics world to a binary dump, a .bullet file.
|
||||||
*
|
*
|
||||||
* @note Should be used only for debugging purporses.
|
* @note Should be used only for debugging purposes.
|
||||||
*
|
*
|
||||||
* @param world the world to be serialized.
|
* @param world the world to be serialized.
|
||||||
* @param path where the serialized world should be written to.
|
* @param path where the serialized world should be written to.
|
||||||
|
@ -1079,7 +1079,7 @@ EAPI void ephysics_world_del(EPhysics_World *world);
|
||||||
*
|
*
|
||||||
* A world can be played / paused. When running, it will simulate the
|
* A world can be played / paused. When running, it will simulate the
|
||||||
* physics step by step. When paused, it will stop simulation. Consequently
|
* physics step by step. When paused, it will stop simulation. Consequently
|
||||||
* all the registered callbacks won't be called since no event will ocurr
|
* all the registered callbacks won't be called since no event will occur
|
||||||
* (no collisions, no object updates).
|
* (no collisions, no object updates).
|
||||||
*
|
*
|
||||||
* When a world is created it starts running.
|
* 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
|
||||||
* Also, keep in mind
|
* Also, keep in mind
|
||||||
* that if you're using CPU intense calculations maybe this framerate won't
|
* that if you're using CPU intense calculations maybe this framerate won't
|
||||||
* be achieved, so the time step will be bigger. You need to define
|
* be achieved, so the time step will be bigger. You need to define
|
||||||
* what range of frames per secons you need to support and configure
|
* what range of frames per seconds you need to support and configure
|
||||||
* @p max_sub_steps and @p fixed_time_step according to this.
|
* @p max_sub_steps and @p fixed_time_step according to this.
|
||||||
*
|
*
|
||||||
* By decreasing the size of @p fixed_time_step, you are increasing the
|
* 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);
|
||||||
* @li or @ref ephysics_body_shape_add().
|
* @li or @ref ephysics_body_shape_add().
|
||||||
*
|
*
|
||||||
* Also they can be soft bodies, that won't act as rigid bodies. They will
|
* Also they can be soft bodies, that won't act as rigid bodies. They will
|
||||||
* deform its shape under certain circunstances, like under collisions.
|
* deform its shape under certain circumstances, like under collisions.
|
||||||
* Soft bodies can be created with:
|
* Soft bodies can be created with:
|
||||||
* @li @ref ephysics_body_soft_cylinder_add();
|
* @li @ref ephysics_body_soft_cylinder_add();
|
||||||
* @li @ref ephysics_body_soft_box_add();
|
* @li @ref ephysics_body_soft_box_add();
|
||||||
|
@ -2011,7 +2011,7 @@ EAPI Eina_Bool ephysics_world_stack_enable_get(const EPhysics_World *world);
|
||||||
* be affected by gravity.
|
* be affected by gravity.
|
||||||
*
|
*
|
||||||
* Forces will be acting while they're set, changing bodies velocity over time.
|
* Forces will be acting while they're set, changing bodies velocity over time.
|
||||||
* Impulses are applied only once, modifying bodies velocity imediatelly to the
|
* Impulses are applied only once, modifying bodies velocity immediately to the
|
||||||
* new value.
|
* new value.
|
||||||
*
|
*
|
||||||
* Forces can be managed with:
|
* Forces can be managed with:
|
||||||
|
@ -2194,7 +2194,7 @@ typedef enum _EPhysics_Body_Cloth_Anchor_Side
|
||||||
* @enum _EPhysics_Body_Face
|
* @enum _EPhysics_Body_Face
|
||||||
* @typedef EPhysics_Body_Face
|
* @typedef EPhysics_Body_Face
|
||||||
*
|
*
|
||||||
* Define in wich body's face the evas object should be set.
|
* Define in which body's face the evas object should be set.
|
||||||
*
|
*
|
||||||
* @see ephysics_body_face_evas_object_set()
|
* @see ephysics_body_face_evas_object_set()
|
||||||
* @see ephysics_body_face_evas_object_unset()
|
* @see ephysics_body_face_evas_object_unset()
|
||||||
|
|
|
@ -150,7 +150,7 @@ typedef enum _Evas_Button_Flags
|
||||||
typedef enum _Evas_Event_Flags
|
typedef enum _Evas_Event_Flags
|
||||||
{
|
{
|
||||||
EVAS_EVENT_FLAG_NONE = 0, /**< No fancy flags set */
|
EVAS_EVENT_FLAG_NONE = 0, /**< No fancy flags set */
|
||||||
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 */
|
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 */
|
||||||
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 */
|
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 */
|
||||||
} Evas_Event_Flags; /**< Flags for Events */
|
} Evas_Event_Flags; /**< Flags for Events */
|
||||||
|
|
||||||
|
@ -378,7 +378,7 @@ typedef enum _Evas_Aspect_Control
|
||||||
typedef enum _Evas_Display_Mode
|
typedef enum _Evas_Display_Mode
|
||||||
{
|
{
|
||||||
EVAS_DISPLAY_MODE_NONE = 0, /**<Default mode */
|
EVAS_DISPLAY_MODE_NONE = 0, /**<Default mode */
|
||||||
EVAS_DISPLAY_MODE_COMPRESS = 1, /**< Use this mode when you want to give comppress display mode hint to an object */
|
EVAS_DISPLAY_MODE_COMPRESS = 1, /**< Use this mode when you want to give compress display mode hint to an object */
|
||||||
EVAS_DISPLAY_MODE_EXPAND = 2, /**< Use this mode when you want to give expand display mode hint to an object */
|
EVAS_DISPLAY_MODE_EXPAND = 2, /**< Use this mode when you want to give expand display mode hint to an object */
|
||||||
EVAS_DISPLAY_MODE_DONT_CHANGE = 3 /**< Use this mode when an object should not change its display mode */
|
EVAS_DISPLAY_MODE_DONT_CHANGE = 3 /**< Use this mode when an object should not change its display mode */
|
||||||
} Evas_Display_Mode; /**< object's display mode type related with compress/expand or etc mode */
|
} 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
|
||||||
/**
|
/**
|
||||||
* @typedef Evas_Textgrid_Palette
|
* @typedef Evas_Textgrid_Palette
|
||||||
*
|
*
|
||||||
* The palette to use for the forgraound and background colors.
|
* The palette to use for the foreground and background colors.
|
||||||
*
|
*
|
||||||
* @since 1.7
|
* @since 1.7
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -15,7 +15,7 @@ extern "C" {
|
||||||
* to use OpenGL to render to specially set up image objects (which act as
|
* to use OpenGL to render to specially set up image objects (which act as
|
||||||
* render target surfaces).
|
* render target surfaces).
|
||||||
*
|
*
|
||||||
* Below is an illlustrative example of how to use OpenGL to render to an
|
* Below is an illustrative example of how to use OpenGL to render to an
|
||||||
* object in Evas.
|
* object in Evas.
|
||||||
*
|
*
|
||||||
* @code
|
* @code
|
||||||
|
@ -91,14 +91,14 @@ main(int argc, char **argv)
|
||||||
|
|
||||||
// set up the image object. a filled one by default
|
// set up the image object. a filled one by default
|
||||||
r1 = evas_object_image_filled_add(canvas);
|
r1 = evas_object_image_filled_add(canvas);
|
||||||
// attach important data we need to the object using key names. this just
|
// attach important data we need to the object using key names. This just
|
||||||
// avoids some global variables and means we can do nice cleanup. you can
|
// avoids some global variables and means we can do nice cleanup. You can
|
||||||
// avoid this if you are lazy
|
// avoid this if you are lazy
|
||||||
evas_object_data_set(r1, "..gld", gld);
|
evas_object_data_set(r1, "..gld", gld);
|
||||||
// when the object is deleted - call the on_del callback. like the above,
|
// when the object is deleted - call the on_del callback. like the above,
|
||||||
// this is just being clean
|
// this is just being clean
|
||||||
evas_object_event_callback_add(r1, EVAS_CALLBACK_DEL, on_del, NULL);
|
evas_object_event_callback_add(r1, EVAS_CALLBACK_DEL, on_del, NULL);
|
||||||
// set up an actual pixel size fot the buffer data. it may be different
|
// set up an actual pixel size fot the buffer data. It may be different
|
||||||
// to the output size. any windowing system has something like this, just
|
// to the output size. any windowing system has something like this, just
|
||||||
// evas has 2 sizes, a pixel size and the output object size
|
// evas has 2 sizes, a pixel size and the output object size
|
||||||
evas_object_image_size_set(r1, w, h);
|
evas_object_image_size_set(r1, w, h);
|
||||||
|
@ -462,7 +462,7 @@ struct _Evas_GL_Config
|
||||||
* Creates a new Evas_GL object and returns a handle for gl rendering on efl.
|
* Creates a new Evas_GL object and returns a handle for gl rendering on efl.
|
||||||
*
|
*
|
||||||
* @param e The given evas canvas OpenGL is to be used on.
|
* @param e The given evas canvas OpenGL is to be used on.
|
||||||
* @return The created evas_gl object, or NULl on fasilure.
|
* @return The created evas_gl object, or NULL on failure.
|
||||||
*/
|
*/
|
||||||
EAPI Evas_GL *evas_gl_new (Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
EAPI Evas_GL *evas_gl_new (Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
||||||
|
|
||||||
|
|
|
@ -966,7 +966,7 @@ EAPI void evas_post_event_callback_remove_full(Evas *e, Evas_Object_Event_Post_
|
||||||
EAPI void evas_event_default_flags_set(Evas *e, Evas_Event_Flags flags) EINA_ARG_NONNULL(1);
|
EAPI void evas_event_default_flags_set(Evas *e, Evas_Event_Flags flags) EINA_ARG_NONNULL(1);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the defaulty set of flags an event begins with
|
* Get the default set of flags an event begins with
|
||||||
*
|
*
|
||||||
* @param e The canvas to get the default event flags from
|
* @param e The canvas to get the default event flags from
|
||||||
* @return The default event flags for that canvas
|
* @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_
|
||||||
* Get the maximum image size evas can possibly handle
|
* Get the maximum image size evas can possibly handle
|
||||||
*
|
*
|
||||||
* @param e The given evas pointer.
|
* @param e The given evas pointer.
|
||||||
* @param maxw Pointer to hold the return value in pixels of the maxumum width
|
* @param maxw Pointer to hold the return value in pixels of the maximum width
|
||||||
* @param maxh Pointer to hold the return value in pixels of the maximum height
|
* @param maxh Pointer to hold the return value in pixels of the maximum height
|
||||||
*
|
*
|
||||||
* This function returns the larges image or surface size that evas can handle
|
* 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);
|
||||||
* @param w Pointer to an integer in which to store the minimum width.
|
* @param w Pointer to an integer in which to store the minimum width.
|
||||||
* @param h Pointer to an integer in which to store the minimum height.
|
* @param h Pointer to an integer in which to store the minimum height.
|
||||||
*
|
*
|
||||||
* These are hints on the minimim sizes @p obj should have. This is
|
* These are hints on the minimum sizes @p obj should have. This is
|
||||||
* not a size enforcement in any way, it's just a hint that should be
|
* not a size enforcement in any way, it's just a hint that should be
|
||||||
* used whenever appropriate.
|
* used whenever appropriate.
|
||||||
*
|
*
|
||||||
|
@ -5321,7 +5321,7 @@ EAPI Evas_Coord evas_object_text_inset_get(const Evas_Object *obj) EIN
|
||||||
/**
|
/**
|
||||||
* Retrieve position and dimension information of a character within a text @c Evas_Object.
|
* Retrieve position and dimension information of a character within a text @c Evas_Object.
|
||||||
*
|
*
|
||||||
* This function is used to obtain the X, Y, width and height of a the character
|
* This function is used to obtain the X, Y, width and height of the character
|
||||||
* located at @p pos within the @c Evas_Object @p obj. @p obj must be a text object
|
* located at @p pos within the @c Evas_Object @p obj. @p obj must be a text object
|
||||||
* as created with evas_object_text_add(). Any of the @c Evas_Coord parameters (@p cx,
|
* as created with evas_object_text_add(). Any of the @c Evas_Coord parameters (@p cx,
|
||||||
* @p cy, @p cw, @p ch) may be @c NULL in which case no value will be assigned to that
|
* @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
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the logical position of the last char in the text
|
* Returns the logical position of the last char in the text
|
||||||
* up to the pos given. this is NOT the position of the last char
|
* up to the pos given. This is NOT the position of the last char
|
||||||
* because of the possibility of RTL in the text.
|
* because of the possibility of RTL in the text.
|
||||||
*/
|
*/
|
||||||
EAPI int evas_object_text_last_up_to_pos(const Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
|
EAPI 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
|
||||||
*
|
*
|
||||||
* @param obj The textgrid object to query for font information.
|
* @param obj The textgrid object to query for font information.
|
||||||
* @param pal The type of the palette to set the color.
|
* @param pal The type of the palette to set the color.
|
||||||
* @param idx The index of the paletter to wich the color is stored.
|
* @param idx The index of the paletter to which the color is stored.
|
||||||
* @param r The red component of the color.
|
* @param r The red component of the color.
|
||||||
* @param g The green component of the color.
|
* @param g The green component of the color.
|
||||||
* @param b The blue component of the color.
|
* @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
|
||||||
*
|
*
|
||||||
* @param obj The textgrid object to query for font information.
|
* @param obj The textgrid object to query for font information.
|
||||||
* @param pal The type of the palette to set the color.
|
* @param pal The type of the palette to set the color.
|
||||||
* @param idx The index of the paletter to wich the color is stored.
|
* @param idx The index of the palette to which the color is stored.
|
||||||
* @param r A pointer to the red component of the color.
|
* @param r A pointer to the red component of the color.
|
||||||
* @param g A pointer to the green component of the color.
|
* @param g A pointer to the green component of the color.
|
||||||
* @param b A pointer to the blue component of the color.
|
* @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
|
||||||
* widths as to fit the remaining space. The @c weight_x property,
|
* widths as to fit the remaining space. The @c weight_x property,
|
||||||
* besides telling the element is resizable, gives a @b weight for the
|
* besides telling the element is resizable, gives a @b weight for the
|
||||||
* resizing process. The parent box will try to distribute (or take
|
* resizing process. The parent box will try to distribute (or take
|
||||||
* off) widths accordingly to the @b normalized list of weigths: most
|
* off) widths accordingly to the @b normalized list of weights: most
|
||||||
* weighted children remain/get larger in this process than the least
|
* weighted children remain/get larger in this process than the least
|
||||||
* ones. @c weight_y does not influence the layout.
|
* ones. @c weight_y does not influence the layout.
|
||||||
*
|
*
|
||||||
|
@ -7016,7 +7016,7 @@ EAPI void evas_object_box_layout_homogeneous_vertical(Evas
|
||||||
* \par Box's properties:
|
* \par Box's properties:
|
||||||
* @c align_h has no influence on the box for this layout.
|
* @c align_h has no influence on the box for this layout.
|
||||||
* @c padding_h tells the box to draw empty spaces of that size, in
|
* @c padding_h tells the box to draw empty spaces of that size, in
|
||||||
* pixels, between the (equal) child objects's cells. The @c align_v
|
* pixels, between the (equal) child objects' cells. The @c align_v
|
||||||
* and @c padding_v properties of the box don't contribute to its
|
* and @c padding_v properties of the box don't contribute to its
|
||||||
* behaviour when this layout is chosen.
|
* behaviour when this layout is chosen.
|
||||||
*
|
*
|
||||||
|
@ -7057,7 +7057,7 @@ EAPI void evas_object_box_layout_homogeneous_horizontal(Ev
|
||||||
*
|
*
|
||||||
* \par Box's properties:
|
* \par Box's properties:
|
||||||
* @c padding_h tells the box to draw empty spaces of that size, in
|
* @c padding_h tells the box to draw empty spaces of that size, in
|
||||||
* pixels, between the child objects's cells. @c align_h controls the
|
* pixels, between the child objects' cells. @c align_h controls the
|
||||||
* horizontal alignment of the child objects, relative to the
|
* horizontal alignment of the child objects, relative to the
|
||||||
* containing box. When set to @c 0.0, children are aligned to the
|
* containing box. When set to @c 0.0, children are aligned to the
|
||||||
* left. A value of @c 1.0 lets them aligned to the right
|
* 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
|
||||||
*
|
*
|
||||||
* \par Box's properties:
|
* \par Box's properties:
|
||||||
* @c padding_h tells the box to draw empty spaces of that size, in
|
* @c padding_h tells the box to draw empty spaces of that size, in
|
||||||
* pixels, between the child objects's cells. @c align_h dictates the
|
* pixels, between the child objects' cells. @c align_h dictates the
|
||||||
* horizontal alignment of the rows (@c 0.0 to left align them, @c 1.0
|
* horizontal alignment of the rows (@c 0.0 to left align them, @c 1.0
|
||||||
* to right align). A value of @c -1.0 to @c align_h lets the rows
|
* to right align). A value of @c -1.0 to @c align_h lets the rows
|
||||||
* @b justified horizontally. @c align_v controls the vertical alignment
|
* @b justified horizontally. @c align_v controls the vertical alignment
|
||||||
|
|
Loading…
Reference in New Issue