summaryrefslogtreecommitdiff
path: root/legacy
diff options
context:
space:
mode:
authorSanjeev BA <iamsanjeev@gmail.com>2011-10-22 09:36:52 +0000
committerSanjeev BA <iamsanjeev@gmail.com>2011-10-22 09:36:52 +0000
commitbfa7a1c2ea8c9264c01cee25b126247f19422416 (patch)
tree000c94d7dc2f8f5d218044452f240de09a398114 /legacy
parent9a12b8f12b95f021ddafc22fb824dbee8b52addb (diff)
Some more documentation fixes.
SVN revision: 64293
Diffstat (limited to 'legacy')
-rw-r--r--legacy/elementary/src/lib/Elementary.h.in26
1 files changed, 13 insertions, 13 deletions
diff --git a/legacy/elementary/src/lib/Elementary.h.in b/legacy/elementary/src/lib/Elementary.h.in
index abf3b5b274..fc5ab77d26 100644
--- a/legacy/elementary/src/lib/Elementary.h.in
+++ b/legacy/elementary/src/lib/Elementary.h.in
@@ -1004,7 +1004,7 @@ extern "C" {
1004#define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL) 1004#define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
1005 1005
1006 /** 1006 /**
1007 * Set the text for an objects part, marking it as translatable 1007 * Set the text for an objects' part, marking it as translatable.
1008 * 1008 *
1009 * The string to set as @p text must be the original one. Do not pass the 1009 * The string to set as @p text must be the original one. Do not pass the
1010 * return of @c gettext() here. Elementary will translate the string 1010 * return of @c gettext() here. Elementary will translate the string
@@ -1019,7 +1019,7 @@ extern "C" {
1019 * its own translatable strings, that should not be mixed with those of 1019 * its own translatable strings, that should not be mixed with those of
1020 * programs using the library. 1020 * programs using the library.
1021 * 1021 *
1022 * @param obj The object 1022 * @param obj The object containing the text part
1023 * @param part The name of the part to set 1023 * @param part The name of the part to set
1024 * @param domain The translation domain to use 1024 * @param domain The translation domain to use
1025 * @param text The original, non-translated text to set 1025 * @param text The original, non-translated text to set
@@ -1095,9 +1095,9 @@ extern "C" {
1095#define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL) 1095#define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1096 1096
1097 /** 1097 /**
1098 * Get the wiget object's handle which contains a given item 1098 * Get the widget object's handle which contains a given item
1099 * 1099 *
1100 * @param item The Elementary object item 1100 * @param item The Elementary object item
1101 * @return The widget object 1101 * @return The widget object
1102 * 1102 *
1103 * @note This returns the widget object itself that an item belongs to. 1103 * @note This returns the widget object itself that an item belongs to.
@@ -1166,7 +1166,7 @@ extern "C" {
1166#define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label)) 1166#define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1167 1167
1168 /** 1168 /**
1169 * Get a label of an object 1169 * Get a label of an object item
1170 * 1170 *
1171 * @param it The Elementary object item 1171 * @param it The Elementary object item
1172 * @param part The text part name to get (NULL for the default label) 1172 * @param part The text part name to get (NULL for the default label)
@@ -1321,7 +1321,7 @@ extern "C" {
1321 /** 1321 /**
1322 * Set the configured cache flush enabled state 1322 * Set the configured cache flush enabled state
1323 * 1323 *
1324 * This sets the globally configured cache flush enabled state 1324 * This sets the globally configured cache flush enabled state.
1325 * 1325 *
1326 * @param size The cache flush enabled state 1326 * @param size The cache flush enabled state
1327 * @ingroup Caches 1327 * @ingroup Caches
@@ -1345,7 +1345,7 @@ extern "C" {
1345 /** 1345 /**
1346 * Get the configured font cache size 1346 * Get the configured font cache size
1347 * 1347 *
1348 * This gets the globally configured font cache size, in bytes 1348 * This gets the globally configured font cache size, in bytes.
1349 * 1349 *
1350 * @return The font cache size 1350 * @return The font cache size
1351 * @ingroup Caches 1351 * @ingroup Caches
@@ -4777,7 +4777,7 @@ extern "C" {
4777 * 4777 *
4778 * @param obj The icon object 4778 * @param obj The icon object
4779 * @param file The path to file that will be used as icon image 4779 * @param file The path to file that will be used as icon image
4780 * @param group The group that the icon belongs to in edje file 4780 * @param group The group that the icon belongs to an edje file
4781 * 4781 *
4782 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error) 4782 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4783 * 4783 *
@@ -4810,8 +4810,8 @@ extern "C" {
4810 * Get the file that will be used as icon. 4810 * Get the file that will be used as icon.
4811 * 4811 *
4812 * @param obj The icon object 4812 * @param obj The icon object
4813 * @param file The path to file that will be used as icon icon image 4813 * @param file The path to file that will be used as the icon image
4814 * @param group The group that the icon belongs to in edje file 4814 * @param group The group that the icon belongs to, in edje file
4815 * 4815 *
4816 * @see elm_icon_file_set() 4816 * @see elm_icon_file_set()
4817 * 4817 *
@@ -4860,7 +4860,7 @@ extern "C" {
4860 */ 4860 */
4861 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); 4861 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4862 /** 4862 /**
4863 * Set the smooth effect for an icon object. 4863 * Set the smooth scaling for an icon object.
4864 * 4864 *
4865 * @param obj The icon object 4865 * @param obj The icon object
4866 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE 4866 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
@@ -4880,7 +4880,7 @@ extern "C" {
4880 */ 4880 */
4881 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1); 4881 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4882 /** 4882 /**
4883 * Get the smooth effect for an icon object. 4883 * Get whether smooth scaling is enabled for an icon object.
4884 * 4884 *
4885 * @param obj The icon object 4885 * @param obj The icon object
4886 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise. 4886 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
@@ -12380,7 +12380,7 @@ extern "C" {
12380 * 12380 *
12381 * This function sets the corner of the bubble. The corner will be used to 12381 * This function sets the corner of the bubble. The corner will be used to
12382 * determine where the arrow in the frame points to and where label, icon and 12382 * determine where the arrow in the frame points to and where label, icon and
12383 * info arre shown. 12383 * info are shown.
12384 * 12384 *
12385 * Possible values for corner are: 12385 * Possible values for corner are:
12386 * @li "top_left" - Default 12386 * @li "top_left" - Default