summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorAmitesh Singh <amitesh.sh@samsung.com>2015-09-28 15:42:51 +0530
committerAmitesh Singh <amitesh.sh@samsung.com>2015-09-28 15:42:51 +0530
commit139d452efeb846f7684f93e9bd7733969d8048b7 (patch)
tree467580e27cea316ee727d07679972ebbda6e5386 /src
parent3894c3e1e0e133078889e416c7d6f3c82a255bb9 (diff)
edje: fix typos in documentation
Diffstat (limited to 'src')
-rw-r--r--src/lib/edje/Edje_Common.h2
-rw-r--r--src/lib/edje/Edje_Edit.h56
2 files changed, 29 insertions, 29 deletions
diff --git a/src/lib/edje/Edje_Common.h b/src/lib/edje/Edje_Common.h
index 468b163c0a..8d03684e1b 100644
--- a/src/lib/edje/Edje_Common.h
+++ b/src/lib/edje/Edje_Common.h
@@ -914,7 +914,7 @@ EAPI double edje_scale_get (void);
914 * 914 *
915 * In Edje it's possible to use a text part as a entry so the user is 915 * In Edje it's possible to use a text part as a entry so the user is
916 * able to make inputs of text. To do so, the text part must be set 916 * able to make inputs of text. To do so, the text part must be set
917 * with a input panel taht will work as a virtual keyboard. 917 * with a input panel that will work as a virtual keyboard.
918 * 918 *
919 * Some of effects can be applied to the entered text and also plenty 919 * Some of effects can be applied to the entered text and also plenty
920 * actions can be performed after any input. 920 * actions can be performed after any input.
diff --git a/src/lib/edje/Edje_Edit.h b/src/lib/edje/Edje_Edit.h
index 54f9cdc07e..8f7ad5f582 100644
--- a/src/lib/edje/Edje_Edit.h
+++ b/src/lib/edje/Edje_Edit.h
@@ -277,7 +277,7 @@ EAPI Eina_Bool edje_edit_clean_save_as(Evas_Object *obj, const char* new_file_na
277 * because this function DOES NOT generate source code for groups. 277 * because this function DOES NOT generate source code for groups.
278 * 278 *
279 * @note With using this function all source code will be erased. And DOES NOT 279 * @note With using this function all source code will be erased. And DOES NOT
280 * generated new code. In attempt to decompile edj file, wich was saved with 280 * generated new code. In attempt to decompile edj file, which was saved with
281 * using this functions will unpacked only resources(like fonts, images, sounds). 281 * using this functions will unpacked only resources(like fonts, images, sounds).
282 * If needed saving source code into file, please use @see edje_edit_save() or 282 * If needed saving source code into file, please use @see edje_edit_save() or
283 * @see edje_edit_save_all(). 283 * @see edje_edit_save_all().
@@ -368,7 +368,7 @@ EAPI Eina_Bool edje_edit_group_copy(Evas_Object *obj, const char *group_name, co
368 * references the next time is loaded. 368 * references the next time is loaded.
369 * @see edje_edit_save_all(), edje_edit_without_source_save(). 369 * @see edje_edit_save_all(), edje_edit_without_source_save().
370 * 370 *
371 * @attention be carefull, if you deleting group, it will delete all it's aliases also, 371 * @attention be careful, if you deleting group, it will delete all it's aliases also,
372 * if you deleting alias, then it will delete alias only. 372 * if you deleting alias, then it will delete alias only.
373 * 373 *
374 */ 374 */
@@ -1255,7 +1255,7 @@ EAPI const char * edje_edit_part_source_get(Evas_Object *obj, const char *part);
1255/** Set the source of part. 1255/** Set the source of part.
1256 * 1256 *
1257 * If setting source of the part will lead to recursive reference 1257 * If setting source of the part will lead to recursive reference
1258 * (when A source to B, and B is going to be source to A because of this funciton), 1258 * (when A source to B, and B is going to be source to A because of this function),
1259 * then it will return EINA_FALSE. 1259 * then it will return EINA_FALSE.
1260 * 1260 *
1261 * @param obj Object being edited. 1261 * @param obj Object being edited.
@@ -2603,7 +2603,7 @@ EAPI int edje_edit_part_item_spread_w_get(Evas_Object *obj, const char *part, co
2603 2603
2604/** Set the spread width value of a part's item. 2604/** Set the spread width value of a part's item.
2605 * 2605 *
2606 * @attention be carefull, if you set up huge number (like 10 or 100). width and height of 2606 * @attention be careful, if you set up huge number (like 10 or 100). width and height of
2607 * spread is being multiplied and you will get huge number of objects that may "eat" 2607 * spread is being multiplied and you will get huge number of objects that may "eat"
2608 * all of your processor performance at once... Or if you want, you may 2608 * all of your processor performance at once... Or if you want, you may
2609 * get some coffee and wait until it will recalculate all of those objects :) 2609 * get some coffee and wait until it will recalculate all of those objects :)
@@ -2620,7 +2620,7 @@ EAPI Eina_Bool edje_edit_part_item_spread_w_set(Evas_Object *obj, const char *pa
2620 2620
2621/** Get the spread height value of a part's item. 2621/** Get the spread height value of a part's item.
2622 * 2622 *
2623 * @attention be carefull, if you set up huge number (like 10 or 100). width and height of 2623 * @attention be careful, if you set up huge number (like 10 or 100). width and height of
2624 * spread is being multiplied and you will get huge number of objects that may "eat" 2624 * spread is being multiplied and you will get huge number of objects that may "eat"
2625 * all of your processor performance at once... Or if you want, you may 2625 * all of your processor performance at once... Or if you want, you may
2626 * get some coffee and wait until it will recalculate all of those objects :) 2626 * get some coffee and wait until it will recalculate all of those objects :)
@@ -2740,7 +2740,7 @@ EAPI double edje_edit_part_item_weight_x_get(Evas_Object *obj, const char *part,
2740 * @param item The name of the item to set horizontal weight value. 2740 * @param item The name of the item to set horizontal weight value.
2741 * @param weight_x New value of the horizontal weight. 2741 * @param weight_x New value of the horizontal weight.
2742 * 2742 *
2743 * @return @c EINA_TRUE If successfull, @c EINA_FALSE otherwise. 2743 * @return @c EINA_TRUE If successful, @c EINA_FALSE otherwise.
2744 * @since 1.11 2744 * @since 1.11
2745 */ 2745 */
2746EAPI Eina_Bool edje_edit_part_item_weight_x_set(Evas_Object *obj, const char *part, const char *item, double weight_x); 2746EAPI Eina_Bool edje_edit_part_item_weight_x_set(Evas_Object *obj, const char *part, const char *item, double weight_x);
@@ -2763,7 +2763,7 @@ EAPI double edje_edit_part_item_weight_y_get(Evas_Object *obj, const char *part,
2763 * @param item The name of the item to set vertical weight value. 2763 * @param item The name of the item to set vertical weight value.
2764 * @param weight_y New value of the vertical weight. 2764 * @param weight_y New value of the vertical weight.
2765 * 2765 *
2766 * @return @c EINA_TRUE If successfull, @c EINA_FALSE otherwise. 2766 * @return @c EINA_TRUE If successful, @c EINA_FALSE otherwise.
2767 * @since 1.11 2767 * @since 1.11
2768 */ 2768 */
2769EAPI Eina_Bool edje_edit_part_item_weight_y_set(Evas_Object *obj, const char *part, const char *item, double weight_y); 2769EAPI Eina_Bool edje_edit_part_item_weight_y_set(Evas_Object *obj, const char *part, const char *item, double weight_y);
@@ -2779,7 +2779,7 @@ EAPI Eina_Bool edje_edit_part_item_weight_y_set(Evas_Object *obj, const char *pa
2779 * @deprecated Use edje_edit_part_item_position_col_get() and 2779 * @deprecated Use edje_edit_part_item_position_col_get() and
2780 * edje_edit_part_item_position_row_get() instead. 2780 * edje_edit_part_item_position_row_get() instead.
2781 * 2781 *
2782 * @return @c EINA_TRUE If successfull, @c EINA_FALSE otherwise. 2782 * @return @c EINA_TRUE If successful, @c EINA_FALSE otherwise.
2783 * @since 1.11 2783 * @since 1.11
2784 */ 2784 */
2785EINA_DEPRECATED 2785EINA_DEPRECATED
@@ -2820,7 +2820,7 @@ edje_edit_part_item_position_row_get(Evas_Object *obj, const char *part, const c
2820 * @deprecation Use edje_edit_part_item_position_col_set() and 2820 * @deprecation Use edje_edit_part_item_position_col_set() and
2821 * edje_edit_part_item_position_row_set() instead. 2821 * edje_edit_part_item_position_row_set() instead.
2822 * 2822 *
2823 * @return @c EINA_TRUE If successfull, @c EINA_FALSE otherwise. 2823 * @return @c EINA_TRUE If successful, @c EINA_FALSE otherwise.
2824 * @since 1.11 2824 * @since 1.11
2825 */ 2825 */
2826EINA_DEPRECATED 2826EINA_DEPRECATED
@@ -2833,7 +2833,7 @@ EAPI Eina_Bool edje_edit_part_item_position_set(Evas_Object *obj, const char *pa
2833 * @param item_name The name of the item. 2833 * @param item_name The name of the item.
2834 * @param col Column item position. 2834 * @param col Column item position.
2835 * 2835 *
2836 * @return @c EINA_TRUE If successfull, @c EINA_FALSE otherwise. 2836 * @return @c EINA_TRUE If successful, @c EINA_FALSE otherwise.
2837 * @since 1.16 2837 * @since 1.16
2838 */ 2838 */
2839EAPI Eina_Bool 2839EAPI Eina_Bool
@@ -2846,7 +2846,7 @@ edje_edit_part_item_position_col_set(Evas_Object *obj, const char *part, const c
2846 * @param item_name The name of the item. 2846 * @param item_name The name of the item.
2847 * @param row Row item position. 2847 * @param row Row item position.
2848 * 2848 *
2849 * @return @c EINA_TRUE If successfull, @c EINA_FALSE otherwise. 2849 * @return @c EINA_TRUE If successful, @c EINA_FALSE otherwise.
2850 * @since 1.16 2850 * @since 1.16
2851 */ 2851 */
2852EAPI Eina_Bool 2852EAPI Eina_Bool
@@ -4010,7 +4010,7 @@ EAPI const Eina_List * edje_edit_state_external_params_list_get(Evas_Object *obj
4010 * @param part Part that contain state. 4010 * @param part Part that contain state.
4011 * @param state The name of the state to get external parameter (not including the state value). 4011 * @param state The name of the state to get external parameter (not including the state value).
4012 * @param value The state value. 4012 * @param value The state value.
4013 * @param param The name of the paramter to look for. 4013 * @param param The name of the parameter to look for.
4014 * @param type The type of the parameter will be stored here. 4014 * @param type The type of the parameter will be stored here.
4015 * @param val Pointer to value will be stored here - DO NOT FREE IT! 4015 * @param val Pointer to value will be stored here - DO NOT FREE IT!
4016 * 4016 *
@@ -4024,7 +4024,7 @@ EAPI Eina_Bool edje_edit_state_external_param_get(Evas_Object *obj, const char *
4024 * @param part Part that contain state. 4024 * @param part Part that contain state.
4025 * @param state The name of the state to get external parameter of type INT (not including the state value). 4025 * @param state The name of the state to get external parameter of type INT (not including the state value).
4026 * @param value The state value. 4026 * @param value The state value.
4027 * @param param The name of the paramter. 4027 * @param param The name of the parameter.
4028 * @param val The value of the parameter. 4028 * @param val The value of the parameter.
4029 * 4029 *
4030 * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of different type. 4030 * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of different type.
@@ -4037,7 +4037,7 @@ EAPI Eina_Bool edje_edit_state_external_param_int_get(Evas_Object *obj, const ch
4037 * @param part Part that contain state. 4037 * @param part Part that contain state.
4038 * @param state The name of the state to get external parameter of type BOOL (not including the state value). 4038 * @param state The name of the state to get external parameter of type BOOL (not including the state value).
4039 * @param value The state value. 4039 * @param value The state value.
4040 * @param param The name of the paramter. 4040 * @param param The name of the parameter.
4041 * @param val The value of the parameter. 4041 * @param val The value of the parameter.
4042 * 4042 *
4043 * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of different type. 4043 * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of different type.
@@ -4050,7 +4050,7 @@ EAPI Eina_Bool edje_edit_state_external_param_bool_get(Evas_Object *obj, const c
4050 * @param part Part that contain state. 4050 * @param part Part that contain state.
4051 * @param state The name of the state to get external parameter of type DOUBLE (not including the state value). 4051 * @param state The name of the state to get external parameter of type DOUBLE (not including the state value).
4052 * @param value The state value. 4052 * @param value The state value.
4053 * @param param The name of the paramter. 4053 * @param param The name of the parameter.
4054 * @param val The value of the parameter. 4054 * @param val The value of the parameter.
4055 * 4055 *
4056 * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of different type. 4056 * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of different type.
@@ -4064,7 +4064,7 @@ EAPI Eina_Bool edje_edit_state_external_param_double_get(Evas_Object *obj, const
4064 * @param state The name of the state to get external parameter of 4064 * @param state The name of the state to get external parameter of
4065 * type STRING (not including the state value). 4065 * type STRING (not including the state value).
4066 * @param value The state value. 4066 * @param value The state value.
4067 * @param param The name of the paramter. 4067 * @param param The name of the parameter.
4068 * @param val The value of the parameter. 4068 * @param val The value of the parameter.
4069 * 4069 *
4070 * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of 4070 * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of
@@ -4079,7 +4079,7 @@ EAPI Eina_Bool edje_edit_state_external_param_string_get(Evas_Object *obj, const
4079 * @param state The name of the state to get external parameter of 4079 * @param state The name of the state to get external parameter of
4080 * type CHOICE (not including the state value). 4080 * type CHOICE (not including the state value).
4081 * @param value The state value. 4081 * @param value The state value.
4082 * @param param The name of the paramter. 4082 * @param param The name of the parameter.
4083 * @param val The value of the parameter. 4083 * @param val The value of the parameter.
4084 * 4084 *
4085 * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of 4085 * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of
@@ -4096,7 +4096,7 @@ EAPI Eina_Bool edje_edit_state_external_param_choice_get(Evas_Object *obj, const
4096 * @param state The name of the state to get external parameter (not 4096 * @param state The name of the state to get external parameter (not
4097 * including the state value). 4097 * including the state value).
4098 * @param value The state value. 4098 * @param value The state value.
4099 * @param param The name of the paramter set. 4099 * @param param The name of the parameter set.
4100 * @param type The type of the parameter. 4100 * @param type The type of the parameter.
4101 * 4101 *
4102 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 4102 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
@@ -4122,7 +4122,7 @@ EAPI Eina_Bool edje_edit_state_external_param_set(Evas_Object *obj, const char *
4122 * @param state The name of the state to get external parameter of 4122 * @param state The name of the state to get external parameter of
4123 * type INT (not including the state value). 4123 * type INT (not including the state value).
4124 * @param value The state value. 4124 * @param value The state value.
4125 * @param param The name of the paramter. 4125 * @param param The name of the parameter.
4126 * @param val Value will be stored here. 4126 * @param val Value will be stored here.
4127 * 4127 *
4128 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 4128 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
@@ -4135,7 +4135,7 @@ EAPI Eina_Bool edje_edit_state_external_param_int_set(Evas_Object *obj, const ch
4135 * @param part Part that contain state. 4135 * @param part Part that contain state.
4136 * @param state The name of the state to get external parameter of type BOOL (not including the state value). 4136 * @param state The name of the state to get external parameter of type BOOL (not including the state value).
4137 * @param value The state value. 4137 * @param value The state value.
4138 * @param param The name of the paramter. 4138 * @param param The name of the parameter.
4139 * @param val Value will be stored here. 4139 * @param val Value will be stored here.
4140 * 4140 *
4141 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 4141 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
@@ -4148,7 +4148,7 @@ EAPI Eina_Bool edje_edit_state_external_param_bool_set(Evas_Object *obj, const c
4148 * @param part Part that contain state. 4148 * @param part Part that contain state.
4149 * @param state The name of the state to get external parameter of type DOUBLE (not including the state value). 4149 * @param state The name of the state to get external parameter of type DOUBLE (not including the state value).
4150 * @param value The state value. 4150 * @param value The state value.
4151 * @param param The name of the paramter. 4151 * @param param The name of the parameter.
4152 * @param val Value will be stored here. 4152 * @param val Value will be stored here.
4153 * 4153 *
4154 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 4154 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
@@ -4161,7 +4161,7 @@ EAPI Eina_Bool edje_edit_state_external_param_double_set(Evas_Object *obj, const
4161 * @param part Part that contain state. 4161 * @param part Part that contain state.
4162 * @param state The name of the state to get external parameter of type STRING (not including the state value). 4162 * @param state The name of the state to get external parameter of type STRING (not including the state value).
4163 * @param value The state value. 4163 * @param value The state value.
4164 * @param param The name of the paramter. 4164 * @param param The name of the parameter.
4165 * @param val Value will be stored here. 4165 * @param val Value will be stored here.
4166 * 4166 *
4167 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 4167 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
@@ -4174,7 +4174,7 @@ EAPI Eina_Bool edje_edit_state_external_param_string_set(Evas_Object *obj, const
4174 * @param part Part that contain state. 4174 * @param part Part that contain state.
4175 * @param state The name of the state to get external parameter of type CHOICE (not including the state value). 4175 * @param state The name of the state to get external parameter of type CHOICE (not including the state value).
4176 * @param value The state value. 4176 * @param value The state value.
4177 * @param param The name of the paramter. 4177 * @param param The name of the parameter.
4178 * @param val Value will be stored here. 4178 * @param val Value will be stored here.
4179 * 4179 *
4180 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 4180 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
@@ -4223,7 +4223,7 @@ EAPI Eina_Bool edje_edit_state_step_get(Evas_Object *obj, const char *part, cons
4223 * from zero or to a zero size in corresponding to the limit value. 4223 * from zero or to a zero size in corresponding to the limit value.
4224 * For example, the signals emitted on width changing are <i>'limit,width,over'</i> 4224 * For example, the signals emitted on width changing are <i>'limit,width,over'</i>
4225 * and <i>'limit,width,zero'</i> 4225 * and <i>'limit,width,zero'</i>
4226 * The availble values are: 4226 * The available values are:
4227 * <ul> 4227 * <ul>
4228 * <li>NONE - 0 (the default value)</li> 4228 * <li>NONE - 0 (the default value)</li>
4229 * <li>WIDTH - 1</li> 4229 * <li>WIDTH - 1</li>
@@ -5459,7 +5459,7 @@ EAPI Eina_Bool edje_edit_sound_sample_add(Evas_Object *obj, const char* name, co
5459 5459
5460/** Delete sound sample from the collection 5460/** Delete sound sample from the collection
5461 * 5461 *
5462 * Deletes sound sample from collection by its name. After successfull deletion 5462 * Deletes sound sample from collection by its name. After successful deletion
5463 * all PLAY_SAMPLE actions in all programs of all groups of current collection 5463 * all PLAY_SAMPLE actions in all programs of all groups of current collection
5464 * that use deleted sound will be deleted. 5464 * that use deleted sound will be deleted.
5465 * 5465 *
@@ -5490,7 +5490,7 @@ EAPI Eina_Bool edje_edit_sound_tone_add(Evas_Object *obj, const char* name, int
5490 5490
5491/** Delete tone from the collection 5491/** Delete tone from the collection
5492 * 5492 *
5493 * Deletes tone from collection by its name. After successfull deletion 5493 * Deletes tone from collection by its name. After successful deletion
5494 * all PLAY_TONE actions in all programs of all groups of current collection 5494 * all PLAY_TONE actions in all programs of all groups of current collection
5495 * that use deleted sound will be deleted. 5495 * that use deleted sound will be deleted.
5496 * 5496 *
@@ -5541,7 +5541,7 @@ EAPI Eina_Bool edje_edit_sound_tone_frequency_set(Evas_Object *obj, const char *
5541 * @param obj Object being edited. 5541 * @param obj Object being edited.
5542 * @param name The name of the tone. 5542 * @param name The name of the tone.
5543 * 5543 *
5544 * @return The frequency of tone if succesful, otherwise returns -1. 5544 * @return The frequency of tone if successful, otherwise returns -1.
5545 * @see edje_edit_sound_tone_frequency_set() 5545 * @see edje_edit_sound_tone_frequency_set()
5546 * @since 1.11 5546 * @since 1.11
5547 */ 5547 */
@@ -6429,7 +6429,7 @@ EAPI Eina_Bool edje_edit_script_program_set(Evas_Object *obj, const char *prog,
6429 * 6429 *
6430 * If required, this function will process all script code for the group and 6430 * If required, this function will process all script code for the group and
6431 * build the bytecode, updating the running Embryo VM Program if the build 6431 * build the bytecode, updating the running Embryo VM Program if the build
6432 * is succesful. 6432 * is successful.
6433 * 6433 *
6434 * @param obj The object being edited 6434 * @param obj The object being edited
6435 * 6435 *