enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 1 Projects Releases Wiki Activity

ecore-drm: Added documentation for various APIs in ecore_drm_output module 

Summary:
Added documentation for ecore_drm_outputs_create, ecore_drm_output_free,
ecore_drm_output_cursor_size_set, ecore_drm_output_size_get functions

@fix

Signed-off-by: vivek <vivek.ellur@samsung.com>

Reviewers: devilhorns

Reviewed By: devilhorns

Subscribers: cedric

Differential Revision: https://phab.enlightenment.org/D1572
This commit is contained in:
vivek 2014-10-23 08:52:02 -04:00 committed by Chris Michael
parent e72c446c8f
commit cd1bc17c1b
1 changed files with 47 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
src/lib/ecore_drm/ecore_drm_output.c
View File

@ -666,6 +666,8 @@ _ecore_drm_output_event(const char *device, Eeze_Udev_Event event, void *data, E
}
}
/* public functions */
/**
* @defgroup Ecore_Drm_Output_Group Ecore DRM Output
*
@ -673,9 +675,18 @@ _ecore_drm_output_event(const char *device, Eeze_Udev_Event event, void *data, E
*
*/
/* TODO: DOXY !! */
/* public functions */
/**
* Create outputs for a drm device
*
* This function will create outputs for Ecore_Drm_Device
*
* @param dev The Ecore_Drm_Device device for which outputs
* needs to be created
*
* @return EINA_TRUE on success, EINA_FALSE on failure.
*
* @ingroup Ecore_Drm_Output_Group
*/
EAPI Eina_Bool
ecore_drm_outputs_create(Ecore_Drm_Device *dev)
{
@ -784,12 +795,33 @@ ecore_drm_outputs_create(Ecore_Drm_Device *dev)
return ret;
}
/**
* Free an Ecore_Drm_Output
*
* This function will cleanup and free any previously allocated Ecore_Drm_Output
*
* @param output The Ecore_Drm_Output to free
*
* @ingroup Ecore_Drm_Output_Group
*/
EAPI void
ecore_drm_output_free(Ecore_Drm_Output *output)
{
_ecore_drm_output_free(output);
}
/**
* Set the cursor size for Ecore_Drm_Output
*
* This function will set the cursor size of Ecore_Drm_Output
*
* @param output The Ecore_Drm_Output to set
* @param handle The Drm handle
* @param w The width of cursor
* @param h The height of cursor
*
* @ingroup Ecore_Drm_Output_Group
*/
EAPI void
ecore_drm_output_cursor_size_set(Ecore_Drm_Output *output, int handle, int w, int h)
{
@ -929,6 +961,18 @@ err:
}
}
/**
* Get the output size of Ecore_Drm_Device
*
* This function will give the output size of Ecore_Drm_Device
*
* @param dev The Ecore_Drm_Device to get output size
* @param output The output id whose information needs to be retrived
* @param *w The parameter in which output width is stored
* @param *h The parameter in which output height is stored
*
* @ingroup Ecore_Drm_Output_Group
*/
EAPI void
ecore_drm_output_size_get(Ecore_Drm_Device *dev, int output, int *w, int *h)
{