summaryrefslogtreecommitdiff
path: root/src/lib/ecore_imf
diff options
context:
space:
mode:
authorWonki Kim <wonki_.kim@samsung.com>2017-10-26 11:53:17 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-10-26 12:17:33 +0900
commit81c6f93933ebd0482b1a964bbfbd74296fb0bdb2 (patch)
treef671b2d9f863c54f590749c6c90c15c163503dd7 /src/lib/ecore_imf
parent9906cd211f805d971733f0815617256429f0304e (diff)
ecore_imf: Add missing documentation comments
Summary: There are missing documentation comments for Ecore_Imf Input. so that this patch add the information. Reviewers: jpeg, cedric Differential Revision: https://phab.enlightenment.org/D5376
Diffstat (limited to 'src/lib/ecore_imf')
-rw-r--r--src/lib/ecore_imf/Ecore_IMF.h37
1 files changed, 31 insertions, 6 deletions
diff --git a/src/lib/ecore_imf/Ecore_IMF.h b/src/lib/ecore_imf/Ecore_IMF.h
index af6cd4e..9352460 100644
--- a/src/lib/ecore_imf/Ecore_IMF.h
+++ b/src/lib/ecore_imf/Ecore_IMF.h
@@ -373,26 +373,41 @@ typedef enum
373 ECORE_IMF_INPUT_HINT_MULTILINE = 1 << 2, /**< Multiline text @since 1.18 */ 373 ECORE_IMF_INPUT_HINT_MULTILINE = 1 << 2, /**< Multiline text @since 1.18 */
374} Ecore_IMF_Input_Hints; 374} Ecore_IMF_Input_Hints;
375 375
376enum 376/**
377 * @typedef Ecore_IMF_Input_Panel_Layout_Normal_Variation
378 * @brief Enumeration for defining the types of Ecore_IMF Input Panel layout for normal variation.
379 * @since 1.12
380 */
381typedef enum
377{ 382{
378 ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_NORMAL, /**< The plain normal layout @since 1.12 */ 383 ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_NORMAL, /**< The plain normal layout @since 1.12 */
379 ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_FILENAME, /**< Filename layout. Symbols such as '/' should be disabled. @since 1.12 */ 384 ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_FILENAME, /**< Filename layout. Symbols such as '/' should be disabled. @since 1.12 */
380 ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_PERSON_NAME /**< The name of a person. @since 1.12 */ 385 ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_PERSON_NAME /**< The name of a person. @since 1.12 */
381}; 386} Ecore_IMF_Input_Layout_Normal_Variation;
382 387
383enum 388/**
389 * @typedef Ecore_IMF_Input_Panel_Layout_Numberonly_Variation
390 * @brief Enumeration for defining the types of Ecore_IMF Input Panel layout for numberonly variation
391 * @since 1.18
392 */
393typedef enum
384{ 394{
385 ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_NORMAL, /**< The plain normal number layout @since 1.8 */ 395 ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_NORMAL, /**< The plain normal number layout @since 1.8 */
386 ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED, /**< The number layout to allow a positive or negative sign at the start @since 1.8 */ 396 ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED, /**< The number layout to allow a positive or negative sign at the start @since 1.8 */
387 ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_DECIMAL, /**< The number layout to allow decimal point to provide fractional value @since 1.8 */ 397 ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_DECIMAL, /**< The number layout to allow decimal point to provide fractional value @since 1.8 */
388 ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED_AND_DECIMAL /**< The number layout to allow decimal point and negative sign @since 1.8 */ 398 ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED_AND_DECIMAL /**< The number layout to allow decimal point and negative sign @since 1.8 */
389}; 399} Ecore_IMF_Input_Panel_Layout_Numberonly_Variation;
390 400
391enum 401/**
402 * @typedef Ecore_IMF_Input_Panel_Layout_Password_Variation
403 * @brief Enumeration for defining the types of Ecore_IMF Input Panel layout for password variation
404 * @since 1.12
405 */
406typedef enum
392{ 407{
393 ECORE_IMF_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NORMAL, /**< The normal password layout @since 1.12 */ 408 ECORE_IMF_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NORMAL, /**< The normal password layout @since 1.12 */
394 ECORE_IMF_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NUMBERONLY /**< The password layout to allow only number @since 1.12 */ 409 ECORE_IMF_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NUMBERONLY /**< The password layout to allow only number @since 1.12 */
395}; 410} Ecore_IMF_Input_Panel_Layout_Password_Variation;
396 411
397/** 412/**
398 * @typedef Ecore_IMF_BiDi_Direction 413 * @typedef Ecore_IMF_BiDi_Direction
@@ -406,6 +421,11 @@ typedef enum
406 ECORE_IMF_BIDI_DIRECTION_RTL /**< The Right to Left mode @since 1.12 */ 421 ECORE_IMF_BIDI_DIRECTION_RTL /**< The Right to Left mode @since 1.12 */
407} Ecore_IMF_BiDi_Direction; 422} Ecore_IMF_BiDi_Direction;
408 423
424/**
425 * @enum _Ecore_IMF_Device_Class
426 * @brief Enumeration for defining the types of Ecore_IMF_Device_Class
427 * @since 1.14
428 */
409typedef enum _Ecore_IMF_Device_Class 429typedef enum _Ecore_IMF_Device_Class
410{ 430{
411 ECORE_IMF_DEVICE_CLASS_NONE, /**< Not a device @since 1.14 */ 431 ECORE_IMF_DEVICE_CLASS_NONE, /**< Not a device @since 1.14 */
@@ -418,6 +438,11 @@ typedef enum _Ecore_IMF_Device_Class
418 ECORE_IMF_DEVICE_CLASS_GAMEPAD /**< A gamepad controller or joystick @since 1.14 */ 438 ECORE_IMF_DEVICE_CLASS_GAMEPAD /**< A gamepad controller or joystick @since 1.14 */
419} Ecore_IMF_Device_Class; /**< A general class of device @since 1.14 */ 439} Ecore_IMF_Device_Class; /**< A general class of device @since 1.14 */
420 440
441/**
442 * @enum _Ecore_IMF_Device_Subclass
443 * @brief Enumeration for defining the types of Ecore_IMF_Device_Subclass
444 * @since 1.14
445 */
421typedef enum _Ecore_IMF_Device_Subclass 446typedef enum _Ecore_IMF_Device_Subclass
422{ 447{
423 ECORE_IMF_DEVICE_SUBCLASS_NONE, /**< Not a device @since 1.14 */ 448 ECORE_IMF_DEVICE_SUBCLASS_NONE, /**< Not a device @since 1.14 */