ecore-drm: Added documentation for various APIs in ecore_drm_device module
authorvivek <vivek.ellur@samsung.com>
Thu, 23 Oct 2014 12:31:20 +0000 (08:31 -0400)
committerChris Michael <cp.michael@samsung.com>
Thu, 23 Oct 2014 12:31:47 +0000 (08:31 -0400)
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

src/lib/ecore_drm/ecore_drm_device.c

index e3e46be..ff9a224 100644 (file)
@@ -531,6 +531,18 @@ ecore_drm_device_master_drop(Ecore_Drm_Device *dev)
    return EINA_TRUE;
 }
 
+/**
+ * Get the file descriptor of Ecore_Drm_Device
+ *
+ * This function will get the file descriptor of drm device
+ *
+ * @param dev The Ecore_Drm_Device to get
+ *
+ * @return fd value on success, -1 on failure
+ *
+ * @ingroup Ecore_Drm_Device_Group
+ *
+ */
 EAPI int 
 ecore_drm_device_fd_get(Ecore_Drm_Device *dev)
 {
@@ -539,8 +551,15 @@ ecore_drm_device_fd_get(Ecore_Drm_Device *dev)
 }
 
 /**
- * TODO: Doxy
- * 
+ * Set the window of Ecore_Drm_Device
+ *
+ * This function will set the window for given drm device
+ *
+ * @param dev The Ecore_Drm_Device for which window is set
+ * @param window The window to set
+ *
+ * @ingroup Ecore_Drm_Device_Group
+ *
  * @since 1.10
  */
 EAPI void 
@@ -553,8 +572,16 @@ ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window)
 }
 
 /**
- * TODO: Doxy
- * 
+ * Get the name of the Ecore_Drm_Device
+ *
+ * This function will return the name of Ecore_Drm_Device
+ *
+ * @param dev The Ecore_Drm_Device to get name
+ *
+ * @return device name on success, NULL on failure
+ *
+ * @ingroup Ecore_Drm_Device_Group
+ *
  * @since 1.10
  */
 EAPI const char *