diff options
author | Bryce Harrington <bryce@osg.samsung.com> | 2017-08-17 10:41:26 -0400 |
---|---|---|
committer | Chris Michael <cp.michael@samsung.com> | 2017-08-17 10:41:26 -0400 |
commit | e3e2a37b0fae699313ea719ea2e8fcea0480b743 (patch) | |
tree | 4e19c9f66d625366ba6d538c52dcbf11e2fc6fd4 /src/lib/elput/Elput.h | |
parent | 0309981eba5a621634e0611ac4313b83027da20f (diff) |
elput: Fix @brief's in docs
Summary:
It is not necessary to specify @brief since the first line will
automatically be used, but if it is used it should be only for the brief
description, not the detailed description.
Also reformat other docs in this file to follow convention for the brief
docs.
Reviewers: cedric
Subscribers: jpeg
Differential Revision: https://phab.enlightenment.org/D5101
Diffstat (limited to '')
-rw-r--r-- | src/lib/elput/Elput.h | 55 |
1 files changed, 32 insertions, 23 deletions
diff --git a/src/lib/elput/Elput.h b/src/lib/elput/Elput.h index b5145d7f81..5636c71204 100644 --- a/src/lib/elput/Elput.h +++ b/src/lib/elput/Elput.h | |||
@@ -251,11 +251,11 @@ EAPI const Eina_List *elput_manager_seats_get(Elput_Manager *manager); | |||
251 | /** | 251 | /** |
252 | * Set which window to use for this input manager | 252 | * Set which window to use for this input manager |
253 | * | 253 | * |
254 | * @brief This function should be used to specify which window to set on the | 254 | * This function should be used to specify which window to set on the |
255 | * input manager. Setting a window on the input manager is done so that | 255 | * input manager. Setting a window on the input manager is done so that |
256 | * when we raise events (mouse movement, keyboard key, etc) then | 256 | * when we raise events (mouse movement, keyboard key, etc) then this |
257 | * this window is passed to the event structure as the window which | 257 | * window is passed to the event structure as the window which the event |
258 | * the event occured on. | 258 | * occured on. |
259 | * | 259 | * |
260 | * @param manager | 260 | * @param manager |
261 | * @param window | 261 | * @param window |
@@ -441,10 +441,11 @@ EAPI void elput_input_pointer_accel_profile_set(Elput_Manager *manager, const ch | |||
441 | */ | 441 | */ |
442 | 442 | ||
443 | /** | 443 | /** |
444 | * Enable or disable tap-and-drag on this device. When enabled, a | 444 | * Enable or disable tap-and-drag on this device. |
445 | * single-finger tap immediately followed by a finger down results in a | 445 | * |
446 | * button down event, subsequent finger motion thus triggers a drag. The | 446 | * When enabled, a single-finger tap immediately followed by a finger |
447 | * button is released on finger up. | 447 | * down results in a button down event, subsequent finger motion thus |
448 | * triggers a drag. The button is released on finger up. | ||
448 | * | 449 | * |
449 | * @param device | 450 | * @param device |
450 | * @param enabled | 451 | * @param enabled |
@@ -457,7 +458,7 @@ EAPI void elput_input_pointer_accel_profile_set(Elput_Manager *manager, const ch | |||
457 | EAPI Eina_Bool elput_touch_drag_enabled_set(Elput_Device *device, Eina_Bool enabled); | 458 | EAPI Eina_Bool elput_touch_drag_enabled_set(Elput_Device *device, Eina_Bool enabled); |
458 | 459 | ||
459 | /** | 460 | /** |
460 | * Get if tap-and-drag is enabled on this device | 461 | * Get if tap-and-drag is enabled on this device. |
461 | * | 462 | * |
462 | * @param device | 463 | * @param device |
463 | * | 464 | * |
@@ -469,10 +470,12 @@ EAPI Eina_Bool elput_touch_drag_enabled_set(Elput_Device *device, Eina_Bool enab | |||
469 | EAPI Eina_Bool elput_touch_drag_enabled_get(Elput_Device *device); | 470 | EAPI Eina_Bool elput_touch_drag_enabled_get(Elput_Device *device); |
470 | 471 | ||
471 | /** | 472 | /** |
472 | * Enable or disable drag-lock during tapping on a device. When enabled, | 473 | * Enable or disable drag-lock during tapping on a device. |
473 | * a finger may be lifted and put back on the touchpad within a timeout and | 474 | * |
474 | * the drag process continues. When disabled, lifting the finger during a | 475 | * When enabled, a finger may be lifted and put back on the touchpad |
475 | * tap-and-drag will immediately stop the drag. | 476 | * within a timeout and the drag process continues. When disabled, |
477 | * lifting the finger during a tap-and-drag will immediately stop the | ||
478 | * drag. | ||
476 | * | 479 | * |
477 | * @param device | 480 | * @param device |
478 | * @param enabled | 481 | * @param enabled |
@@ -485,7 +488,7 @@ EAPI Eina_Bool elput_touch_drag_enabled_get(Elput_Device *device); | |||
485 | EAPI Eina_Bool elput_touch_drag_lock_enabled_set(Elput_Device *device, Eina_Bool enabled); | 488 | EAPI Eina_Bool elput_touch_drag_lock_enabled_set(Elput_Device *device, Eina_Bool enabled); |
486 | 489 | ||
487 | /** | 490 | /** |
488 | * Get if drag-lock is enabled on this device | 491 | * Get if drag-lock is enabled on this device. |
489 | * | 492 | * |
490 | * @param device | 493 | * @param device |
491 | * | 494 | * |
@@ -497,8 +500,10 @@ EAPI Eina_Bool elput_touch_drag_lock_enabled_set(Elput_Device *device, Eina_Bool | |||
497 | EAPI Eina_Bool elput_touch_drag_lock_enabled_get(Elput_Device *device); | 500 | EAPI Eina_Bool elput_touch_drag_lock_enabled_get(Elput_Device *device); |
498 | 501 | ||
499 | /** | 502 | /** |
500 | * Enable or disable touchpad dwt (disable-while-typing) feature. When enabled, the | 503 | * Enable or disable touchpad dwt (disable-while-typing) feature. |
501 | * device will be disabled while typing and for a short period after. | 504 | * |
505 | * When enabled, the device will be disabled while typing and for a | ||
506 | * short period after. | ||
502 | * | 507 | * |
503 | * @param device | 508 | * @param device |
504 | * @param enabled | 509 | * @param enabled |
@@ -523,8 +528,10 @@ EAPI Eina_Bool elput_touch_dwt_enabled_set(Elput_Device *device, Eina_Bool enabl | |||
523 | EAPI Eina_Bool elput_touch_dwt_enabled_get(Elput_Device *device); | 528 | EAPI Eina_Bool elput_touch_dwt_enabled_get(Elput_Device *device); |
524 | 529 | ||
525 | /** | 530 | /** |
526 | * Set the scroll method used for this device. The scroll method defines when | 531 | * Set the scroll method used for this device. |
527 | * to generate scroll axis events instead of pointer motion events. | 532 | * |
533 | * The scroll method defines when to generate scroll axis events instead | ||
534 | * of pointer motion events. | ||
528 | * | 535 | * |
529 | * @param device | 536 | * @param device |
530 | * @param method | 537 | * @param method |
@@ -549,8 +556,10 @@ EAPI Eina_Bool elput_touch_scroll_method_set(Elput_Device *device, int method); | |||
549 | EAPI int elput_touch_scroll_method_get(Elput_Device *device); | 556 | EAPI int elput_touch_scroll_method_get(Elput_Device *device); |
550 | 557 | ||
551 | /** | 558 | /** |
552 | * Set the button click method for a device. The button click method defines | 559 | * Set the button click method for a device. |
553 | * when to generate software emulated buttons | 560 | * |
561 | * The button click method defines when to generate software emulated | ||
562 | * buttons | ||
554 | * | 563 | * |
555 | * @param device | 564 | * @param device |
556 | * @param method | 565 | * @param method |
@@ -605,7 +614,7 @@ EAPI Eina_Bool elput_touch_tap_enabled_get(Elput_Device *device); | |||
605 | * | 614 | * |
606 | * Functions for getting attributes of devices | 615 | * Functions for getting attributes of devices |
607 | */ | 616 | */ |
608 | 617 | ||
609 | /** | 618 | /** |
610 | * Get the seat object for a device | 619 | * Get the seat object for a device |
611 | * @param dev | 620 | * @param dev |
@@ -641,7 +650,7 @@ EAPI Eina_Stringshare *elput_device_output_name_get(Elput_Device *device); | |||
641 | * | 650 | * |
642 | * Functions for getting attributes of seats | 651 | * Functions for getting attributes of seats |
643 | */ | 652 | */ |
644 | 653 | ||
645 | /** | 654 | /** |
646 | * Get the list of devices on a given seat | 655 | * Get the list of devices on a given seat |
647 | * | 656 | * |