summaryrefslogtreecommitdiff
path: root/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
diff options
context:
space:
mode:
authorJérôme Pinot <ngc891@gmail.com>2012-04-12 03:51:36 +0000
committerMike Blumenkrantz <michael.blumenkrantz@gmail.com>2012-04-12 03:51:36 +0000
commit7d464af0a1b5c8b364fe0ffcd2f63ded8b15b08a (patch)
treed433403e1f0b4cd0905a6d874f9c05d9112b0b7d /legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
parent369617c161e4b79b03950c5b507d376b14897d09 (diff)
From: Jérôme Pinot <ngc891@gmail.com>
Subject: [E-devel] [patch] ecore doxygen doc (2) Date: Thu, 12 Apr 2012 12:46:04 +0900 Hi, This is a big patch. It fixes: - undef #EINA_{TRUE,FALSE} links - @c for NULL and EINA_{TRUE,FALSE} - some formatting/spello - several missing return types SVN revision: 70117
Diffstat (limited to '')
-rw-r--r--legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c31
1 files changed, 17 insertions, 14 deletions
diff --git a/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c b/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
index 9ce0a3c785..44c52c072f 100644
--- a/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
+++ b/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
@@ -294,7 +294,7 @@ ecore_imf_context_del(Ecore_IMF_Context *ctx)
294 * also be used for purposes internal to the Input Method Context. 294 * also be used for purposes internal to the Input Method Context.
295 * 295 *
296 * @param ctx An #Ecore_IMF_Context. 296 * @param ctx An #Ecore_IMF_Context.
297 * @param window The client window. This may be NULL to indicate 297 * @param window The client window. This may be @c NULL to indicate
298 * that the previous client window no longer exists. 298 * that the previous client window no longer exists.
299 * @ingroup Ecore_IMF_Context_Group 299 * @ingroup Ecore_IMF_Context_Group
300 */ 300 */
@@ -342,7 +342,7 @@ ecore_imf_context_client_window_get(Ecore_IMF_Context *ctx)
342 * also be used for purposes internal to the Input Method Context. 342 * also be used for purposes internal to the Input Method Context.
343 * 343 *
344 * @param ctx An #Ecore_IMF_Context. 344 * @param ctx An #Ecore_IMF_Context.
345 * @param canvas The client canvas. This may be NULL to indicate 345 * @param canvas The client canvas. This may be @c NULL to indicate
346 * that the previous client canvas no longer exists. 346 * that the previous client canvas no longer exists.
347 * @ingroup Ecore_IMF_Context_Group 347 * @ingroup Ecore_IMF_Context_Group
348 */ 348 */
@@ -660,8 +660,8 @@ ecore_imf_context_cursor_location_set(Ecore_IMF_Context *ctx, int x, int y, int
660 660
661/** 661/**
662 * Set whether the IM context should use the preedit string 662 * Set whether the IM context should use the preedit string
663 * to display feedback. If @c use_preedit is EINA_FALSE (default 663 * to display feedback. If @c use_preedit is @c EINA_FALSE (default
664 * is EINA_TRUE), then the IM context may use some other method to display 664 * is @c EINA_TRUE), then the IM context may use some other method to display
665 * feedback, such as displaying it in a child of the root window. 665 * feedback, such as displaying it in a child of the root window.
666 * 666 *
667 * @param ctx An #Ecore_IMF_Context. 667 * @param ctx An #Ecore_IMF_Context.
@@ -682,7 +682,8 @@ ecore_imf_context_use_preedit_set(Ecore_IMF_Context *ctx, Eina_Bool use_preedit)
682 682
683/** 683/**
684 * Set whether the IM context should allow to use the text prediction. 684 * Set whether the IM context should allow to use the text prediction.
685 * If @c prediction is EINA_FALSE (default is EINA_TRUE), then the IM context will not display the text prediction window. 685 * If @p prediction is @c EINA_FALSE (default is @c EINA_TRUE), then the IM
686 * context will not display the text prediction window.
686 * 687 *
687 * @param ctx An #Ecore_IMF_Context. 688 * @param ctx An #Ecore_IMF_Context.
688 * @param prediction Whether the IM context should allow to use the text prediction. 689 * @param prediction Whether the IM context should allow to use the text prediction.
@@ -709,7 +710,8 @@ ecore_imf_context_prediction_allow_set(Ecore_IMF_Context *ctx, Eina_Bool predict
709 * Get whether the IM context should allow to use the text prediction. 710 * Get whether the IM context should allow to use the text prediction.
710 * 711 *
711 * @param ctx An #Ecore_IMF_Context. 712 * @param ctx An #Ecore_IMF_Context.
712 * @return EINA_TRUE if it allows to use the text prediction, otherwise EINA_FALSE. 713 * @return @c EINA_TRUE if it allows to use the text prediction, otherwise
714 * @c EINA_FALSE.
713 * @ingroup Ecore_IMF_Context_Group 715 * @ingroup Ecore_IMF_Context_Group
714 * @since 1.1.0 716 * @since 1.1.0
715 */ 717 */
@@ -842,17 +844,17 @@ ecore_imf_context_input_mode_get(Ecore_IMF_Context *ctx)
842 844
843/** 845/**
844 * Allow an Ecore Input Context to internally handle an event. 846 * Allow an Ecore Input Context to internally handle an event.
845 * If this function returns EINA_TRUE, then no further processing 847 * If this function returns @c EINA_TRUE, then no further processing
846 * should be done for this event. 848 * should be done for this event.
847 * 849 *
848 * Input methods must be able to accept all types of events (simply 850 * Input methods must be able to accept all types of events (simply
849 * returning EINA_FALSE if the event was not handled), but there is no 851 * returning @c EINA_FALSE if the event was not handled), but there is no
850 * obligation of any events to be submitted to this function. 852 * obligation of any events to be submitted to this function.
851 * 853 *
852 * @param ctx An #Ecore_IMF_Context. 854 * @param ctx An #Ecore_IMF_Context.
853 * @param type The type of event defined by #Ecore_IMF_Event_Type. 855 * @param type The type of event defined by #Ecore_IMF_Event_Type.
854 * @param event The event itself. 856 * @param event The event itself.
855 * @return EINA_TRUE if the event was handled; otherwise EINA_FALSE. 857 * @return @c EINA_TRUE if the event was handled; otherwise @c EINA_FALSE.
856 * @ingroup Ecore_IMF_Context_Group 858 * @ingroup Ecore_IMF_Context_Group
857 * 859 *
858 * Example 860 * Example
@@ -983,11 +985,12 @@ EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context *ctx)
983 * @param ctx An #Ecore_IMF_Context. 985 * @param ctx An #Ecore_IMF_Context.
984 * @param text Location to store a UTF-8 encoded string of text 986 * @param text Location to store a UTF-8 encoded string of text
985 * holding context around the insertion point. 987 * holding context around the insertion point.
986 * If the function returns EINA_TRUE, then you must free 988 * If the function returns @c EINA_TRUE, then you must free
987 * the result stored in this location with free(). 989 * the result stored in this location with free().
988 * @param cursor_pos Location to store the position in characters of 990 * @param cursor_pos Location to store the position in characters of
989 * the insertion cursor within @p text. 991 * the insertion cursor within @p text.
990 * @return EINA_TRUE if surrounding text was provided; otherwise EINA_FALSE. 992 * @return @c EINA_TRUE if surrounding text was provided; otherwise
993 * @c EINA_FALSE.
991 * @ingroup Ecore_IMF_Context_Module_Group 994 * @ingroup Ecore_IMF_Context_Module_Group
992 */ 995 */
993EAPI Eina_Bool 996EAPI Eina_Bool
@@ -1668,7 +1671,7 @@ ecore_imf_context_input_panel_return_key_disabled_set(Ecore_IMF_Context *ctx, Ei
1668 * Get whether the return key on the input panel should be disabled or not. 1671 * Get whether the return key on the input panel should be disabled or not.
1669 * 1672 *
1670 * @param ctx An #Ecore_IMF_Context. 1673 * @param ctx An #Ecore_IMF_Context.
1671 * @return EINA_TRUE if it should be disabled 1674 * @return @c EINA_TRUE if it should be disabled.
1672 * @ingroup Ecore_IMF_Context_Group 1675 * @ingroup Ecore_IMF_Context_Group
1673 * @since 1.2.0 1676 * @since 1.2.0
1674 */ 1677 */
@@ -1689,7 +1692,7 @@ ecore_imf_context_input_panel_return_key_disabled_get(Ecore_IMF_Context *ctx)
1689 * Set the caps lock mode on the input panel. 1692 * Set the caps lock mode on the input panel.
1690 * 1693 *
1691 * @param ctx An #Ecore_IMF_Context. 1694 * @param ctx An #Ecore_IMF_Context.
1692 * @param mode Turn on caps lock on the input panel if EINA_TRUE 1695 * @param mode Turn on caps lock on the input panel if @c EINA_TRUE.
1693 * @ingroup Ecore_IMF_Context_Group 1696 * @ingroup Ecore_IMF_Context_Group
1694 * @since 1.2.0 1697 * @since 1.2.0
1695 */ 1698 */
@@ -1713,7 +1716,7 @@ ecore_imf_context_input_panel_caps_lock_mode_set(Ecore_IMF_Context *ctx, Eina_Bo
1713 * Get the caps lock mode on the input panel. 1716 * Get the caps lock mode on the input panel.
1714 * 1717 *
1715 * @param ctx An #Ecore_IMF_Context. 1718 * @param ctx An #Ecore_IMF_Context.
1716 * @return EINA_TRUE if the caps lock is turned on. 1719 * @return @c EINA_TRUE if the caps lock is turned on.
1717 * @ingroup Ecore_IMF_Context_Group 1720 * @ingroup Ecore_IMF_Context_Group
1718 * @since 1.2.0 1721 * @since 1.2.0
1719 */ 1722 */