summaryrefslogtreecommitdiff
path: root/src/lib/ecore_drm/ecore_drm_device.c
diff options
context:
space:
mode:
authorvivek <vivek.ellur@samsung.com>2014-10-23 08:31:20 -0400
committerChris Michael <cp.michael@samsung.com>2014-10-23 08:31:47 -0400
commit0446fd2d7fbacc71bbb41dec93c345ed1c3181d0 (patch)
treec6836b2ccb507bd2f3240b48d01b01af98fba351 /src/lib/ecore_drm/ecore_drm_device.c
parentdae6bcb62d93b81d2b9e769007e28cb5f95e044b (diff)
ecore-drm: Added documentation for various APIs in ecore_drm_device module
Summary: Added documentation for ecore_drm_device_fd_get, ecore_drm_device_window_set and ecore_drm_device_name_get APIs in ecore_drm_device module. @fix Signed-off-by: vivek <vivek.ellur@samsung.com> Reviewers: devilhorns Subscribers: cedric Differential Revision: https://phab.enlightenment.org/D1568
Diffstat (limited to 'src/lib/ecore_drm/ecore_drm_device.c')
-rw-r--r--src/lib/ecore_drm/ecore_drm_device.c35
1 files changed, 31 insertions, 4 deletions
diff --git a/src/lib/ecore_drm/ecore_drm_device.c b/src/lib/ecore_drm/ecore_drm_device.c
index e3e46be613..ff9a224c1d 100644
--- a/src/lib/ecore_drm/ecore_drm_device.c
+++ b/src/lib/ecore_drm/ecore_drm_device.c
@@ -531,6 +531,18 @@ ecore_drm_device_master_drop(Ecore_Drm_Device *dev)
531 return EINA_TRUE; 531 return EINA_TRUE;
532} 532}
533 533
534/**
535 * Get the file descriptor of Ecore_Drm_Device
536 *
537 * This function will get the file descriptor of drm device
538 *
539 * @param dev The Ecore_Drm_Device to get
540 *
541 * @return fd value on success, -1 on failure
542 *
543 * @ingroup Ecore_Drm_Device_Group
544 *
545 */
534EAPI int 546EAPI int
535ecore_drm_device_fd_get(Ecore_Drm_Device *dev) 547ecore_drm_device_fd_get(Ecore_Drm_Device *dev)
536{ 548{
@@ -539,8 +551,15 @@ ecore_drm_device_fd_get(Ecore_Drm_Device *dev)
539} 551}
540 552
541/** 553/**
542 * TODO: Doxy 554 * Set the window of Ecore_Drm_Device
543 * 555 *
556 * This function will set the window for given drm device
557 *
558 * @param dev The Ecore_Drm_Device for which window is set
559 * @param window The window to set
560 *
561 * @ingroup Ecore_Drm_Device_Group
562 *
544 * @since 1.10 563 * @since 1.10
545 */ 564 */
546EAPI void 565EAPI void
@@ -553,8 +572,16 @@ ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window)
553} 572}
554 573
555/** 574/**
556 * TODO: Doxy 575 * Get the name of the Ecore_Drm_Device
557 * 576 *
577 * This function will return the name of Ecore_Drm_Device
578 *
579 * @param dev The Ecore_Drm_Device to get name
580 *
581 * @return device name on success, NULL on failure
582 *
583 * @ingroup Ecore_Drm_Device_Group
584 *
558 * @since 1.10 585 * @since 1.10
559 */ 586 */
560EAPI const char * 587EAPI const char *