summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorCarsten Haitzler <raster@rasterman.com>2011-12-30 08:23:04 +0000
committerCarsten Haitzler <raster@rasterman.com>2011-12-30 08:23:04 +0000
commitaf01411acdea41fc4a73c71374915a55ec8002c9 (patch)
treeb770b5644b8c8526e96a32a583364bfb3b7473a9 /src
parentecbed3b80ef598178c52ee481f06fe6b7883716b (diff)
fix more doc warnings.
SVN revision: 66670
Diffstat (limited to 'src')
-rw-r--r--src/lib/elc_ctxpopup.h6
-rw-r--r--src/lib/elm_debug.h2
-rw-r--r--src/lib/elm_diskselector.h2
-rw-r--r--src/lib/elm_entry.h26
-rw-r--r--src/lib/elm_flip.h12
-rw-r--r--src/lib/elm_focus.h14
-rw-r--r--src/lib/elm_glview.h2
7 files changed, 33 insertions, 31 deletions
diff --git a/src/lib/elc_ctxpopup.h b/src/lib/elc_ctxpopup.h
index 0621cbfc9..5a64f7272 100644
--- a/src/lib/elc_ctxpopup.h
+++ b/src/lib/elc_ctxpopup.h
@@ -32,7 +32,7 @@
32 * @{ 32 * @{
33 */ 33 */
34 34
35typedef enum _Elm_Ctxpopup_Direction 35typedef enum
36{ 36{
37 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked area */ 37 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked area */
38 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of the clicked area */ 38 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of the clicked area */
@@ -49,9 +49,7 @@ typedef enum _Elm_Ctxpopup_Direction
49 * 49 *
50 * @ingroup Ctxpopup 50 * @ingroup Ctxpopup
51 */ 51 */
52EAPI Evas_Object * 52EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
53 elm_ctxpopup_add(Evas_Object *parent)
54EINA_ARG_NONNULL(1);
55 53
56/** 54/**
57 * @brief Set the Ctxpopup's parent 55 * @brief Set the Ctxpopup's parent
diff --git a/src/lib/elm_debug.h b/src/lib/elm_debug.h
index 97dd18f7b..ef9cdffc0 100644
--- a/src/lib/elm_debug.h
+++ b/src/lib/elm_debug.h
@@ -8,7 +8,7 @@
8/** 8/**
9 * Print Tree object hierarchy in stdout 9 * Print Tree object hierarchy in stdout
10 * 10 *
11 * @param obj The root object 11 * @param top The root object
12 * @ingroup Debug 12 * @ingroup Debug
13 */ 13 */
14EAPI void elm_object_tree_dump(const Evas_Object *top); 14EAPI void elm_object_tree_dump(const Evas_Object *top);
diff --git a/src/lib/elm_diskselector.h b/src/lib/elm_diskselector.h
index 9b95fbd6c..62a7c97f0 100644
--- a/src/lib/elm_diskselector.h
+++ b/src/lib/elm_diskselector.h
@@ -395,7 +395,7 @@ EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item
395/** 395/**
396 * Get the icon associated to the item. 396 * Get the icon associated to the item.
397 * 397 *
398 * @param it The diskselector item 398 * @param item The diskselector item
399 * @return The icon associated to @p it 399 * @return The icon associated to @p it
400 * 400 *
401 * The return value is a pointer to the icon associated to @p item when it was 401 * The return value is a pointer to the icon associated to @p item when it was
diff --git a/src/lib/elm_entry.h b/src/lib/elm_entry.h
index c7638cd72..b5c7a1191 100644
--- a/src/lib/elm_entry.h
+++ b/src/lib/elm_entry.h
@@ -7,14 +7,14 @@ typedef enum _Elm_Text_Format
7/** 7/**
8 * Line wrapping types. 8 * Line wrapping types.
9 */ 9 */
10typedef enum _Elm_Wrap_Type 10typedef enum
11{ 11{
12 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */ 12 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
13 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */ 13 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
14 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */ 14 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
15 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */ 15 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
16 ELM_WRAP_LAST 16 ELM_WRAP_LAST
17} Elm_Wrap_Type; 17} Elm_Wrap_Type; /**< Type of word or character wrapping to use */
18 18
19typedef enum 19typedef enum
20{ 20{
@@ -27,15 +27,15 @@ typedef enum
27 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */ 27 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
28 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */ 28 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
29 ELM_INPUT_PANEL_LAYOUT_INVALID // XXX: remove this so we can expand 29 ELM_INPUT_PANEL_LAYOUT_INVALID // XXX: remove this so we can expand
30} Elm_Input_Panel_Layout; 30} Elm_Input_Panel_Layout; /**< Type of input panel (virtual keyboard) to use */
31 31
32typedef enum 32typedef enum
33{ 33{
34 ELM_AUTOCAPITAL_TYPE_NONE, 34 ELM_AUTOCAPITAL_TYPE_NONE, /**< No auto-capitalization when typing */
35 ELM_AUTOCAPITAL_TYPE_WORD, 35 ELM_AUTOCAPITAL_TYPE_WORD, /**< Autocapitalize each word typed */
36 ELM_AUTOCAPITAL_TYPE_SENTENCE, 36 ELM_AUTOCAPITAL_TYPE_SENTENCE, /**< Autocapitalize the start of each sentence */
37 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER, 37 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Autocapitalize all letters */
38} Elm_Autocapital_Type; 38} Elm_Autocapital_Type; /**< Choose method of auto-capitalization */
39 39
40/** 40/**
41 * @defgroup Entry Entry 41 * @defgroup Entry Entry
@@ -56,7 +56,7 @@ typedef enum
56 * 56 *
57 * They can also be single line or multi line (the default) and when set 57 * They can also be single line or multi line (the default) and when set
58 * to multi line mode they support text wrapping in any of the modes 58 * to multi line mode they support text wrapping in any of the modes
59 * indicated by #Elm_Wrap_Type. 59 * indicated by Elm_Wrap_Type.
60 * 60 *
61 * Other features include password mode, filtering of inserted text with 61 * Other features include password mode, filtering of inserted text with
62 * elm_entry_text_filter_append() and related functions, inline "items" and 62 * elm_entry_text_filter_append() and related functions, inline "items" and
@@ -498,7 +498,7 @@ EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *ent
498 * Set the line wrap type to use on multi-line entries. 498 * Set the line wrap type to use on multi-line entries.
499 * 499 *
500 * Sets the wrap type used by the entry to any of the specified in 500 * Sets the wrap type used by the entry to any of the specified in
501 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new 501 * Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
502 * line (without inserting a line break or paragraph separator) when it 502 * line (without inserting a line break or paragraph separator) when it
503 * reaches the far edge of the widget. 503 * reaches the far edge of the widget.
504 * 504 *
@@ -506,7 +506,7 @@ EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *ent
506 * to be single line will never wrap. 506 * to be single line will never wrap.
507 * 507 *
508 * @param obj The entry object 508 * @param obj The entry object
509 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them 509 * @param wrap The wrap mode to use. See Elm_Wrap_Type for details on them
510 */ 510 */
511EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1); 511EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
512 512
@@ -1104,8 +1104,8 @@ EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scr
1104 * the end of the contained entry. 1104 * the end of the contained entry.
1105 * 1105 *
1106 * @param obj The scrolled entry object 1106 * @param obj The scrolled entry object
1107 * @param h The horizontal bounce state 1107 * @param h_bounce The horizontal bounce state
1108 * @param v The vertical bounce state 1108 * @param v_bounce The vertical bounce state
1109 */ 1109 */
1110EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce); 1110EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
1111 1111
diff --git a/src/lib/elm_flip.h b/src/lib/elm_flip.h
index f7e358e71..75164abce 100644
--- a/src/lib/elm_flip.h
+++ b/src/lib/elm_flip.h
@@ -22,7 +22,7 @@
22 * 22 *
23 * @{ 23 * @{
24 */ 24 */
25typedef enum _Elm_Flip_Mode 25typedef enum
26{ 26{
27 ELM_FLIP_ROTATE_Y_CENTER_AXIS, 27 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
28 ELM_FLIP_ROTATE_X_CENTER_AXIS, 28 ELM_FLIP_ROTATE_X_CENTER_AXIS,
@@ -37,14 +37,16 @@ typedef enum _Elm_Flip_Mode
37 ELM_FLIP_PAGE_UP, 37 ELM_FLIP_PAGE_UP,
38 ELM_FLIP_PAGE_DOWN 38 ELM_FLIP_PAGE_DOWN
39} Elm_Flip_Mode; 39} Elm_Flip_Mode;
40typedef enum _Elm_Flip_Interaction 40
41typedef enum
41{ 42{
42 ELM_FLIP_INTERACTION_NONE, 43 ELM_FLIP_INTERACTION_NONE,
43 ELM_FLIP_INTERACTION_ROTATE, 44 ELM_FLIP_INTERACTION_ROTATE,
44 ELM_FLIP_INTERACTION_CUBE, 45 ELM_FLIP_INTERACTION_CUBE,
45 ELM_FLIP_INTERACTION_PAGE 46 ELM_FLIP_INTERACTION_PAGE
46} Elm_Flip_Interaction; 47} Elm_Flip_Interaction;
47typedef enum _Elm_Flip_Direction 48
49typedef enum
48{ 50{
49 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */ 51 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
50 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */ 52 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
@@ -58,9 +60,7 @@ typedef enum _Elm_Flip_Direction
58 * @param parent The parent object 60 * @param parent The parent object
59 * @return The new object or NULL if it cannot be created 61 * @return The new object or NULL if it cannot be created
60 */ 62 */
61EAPI Evas_Object * 63EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
62 elm_flip_add(Evas_Object *parent)
63EINA_ARG_NONNULL(1);
64 64
65/** 65/**
66 * @brief Set the front content of the flip widget. 66 * @brief Set the front content of the flip widget.
diff --git a/src/lib/elm_focus.h b/src/lib/elm_focus.h
index 0c1a320b1..8b3654acd 100644
--- a/src/lib/elm_focus.h
+++ b/src/lib/elm_focus.h
@@ -43,8 +43,9 @@ EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
43/** 43/**
44 * Set the enable status of the focus highlight 44 * Set the enable status of the focus highlight
45 * 45 *
46 * Set whether to show or not the highlight on focused objects
47 * @param enable Enable highlight if EINA_TRUE, disable otherwise 46 * @param enable Enable highlight if EINA_TRUE, disable otherwise
47 *
48 * Set whether to show or not the highlight on focused objects
48 * @ingroup Focus 49 * @ingroup Focus
49 */ 50 */
50EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable); 51EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
@@ -52,8 +53,11 @@ EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
52/** 53/**
53 * Get the enable status of the highlight animation 54 * Get the enable status of the highlight animation
54 * 55 *
56 * @return The focus hilight mode set
57 *
55 * Get whether the focus highlight, if enabled, will animate its switch from 58 * Get whether the focus highlight, if enabled, will animate its switch from
56 * one object to the next 59 * one object to the next
60 *
57 * @ingroup Focus 61 * @ingroup Focus
58 */ 62 */
59EAPI Eina_Bool elm_focus_highlight_animate_get(void); 63EAPI Eina_Bool elm_focus_highlight_animate_get(void);
@@ -61,9 +65,11 @@ EAPI Eina_Bool elm_focus_highlight_animate_get(void);
61/** 65/**
62 * Set the enable status of the highlight animation 66 * Set the enable status of the highlight animation
63 * 67 *
68 * @param animate Enable animation if EINA_TRUE, disable otherwise
69 *
64 * Set whether the focus highlight, if enabled, will animate its switch from 70 * Set whether the focus highlight, if enabled, will animate its switch from
65 * one object to the next 71 * one object to the next
66 * @param animate Enable animation if EINA_TRUE, disable otherwise 72 *
67 * @ingroup Focus 73 * @ingroup Focus
68 */ 74 */
69EAPI void elm_focus_highlight_animate_set(Eina_Bool animate); 75EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
@@ -79,9 +85,7 @@ EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
79 * 85 *
80 * @ingroup Focus 86 * @ingroup Focus
81 */ 87 */
82EAPI Eina_Bool 88EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
83 elm_object_focus_get(const Evas_Object *obj)
84EINA_ARG_NONNULL(1);
85 89
86/** 90/**
87 * Set/unset focus to a given Elementary object. 91 * Set/unset focus to a given Elementary object.
diff --git a/src/lib/elm_glview.h b/src/lib/elm_glview.h
index cf702e629..e7f6353c7 100644
--- a/src/lib/elm_glview.h
+++ b/src/lib/elm_glview.h
@@ -1,5 +1,5 @@
1/** 1/**
2 * @defgroup GLView 2 * @defgroup GLView GLView
3 * 3 *
4 * A simple GLView widget that allows GL rendering. 4 * A simple GLView widget that allows GL rendering.
5 * 5 *