summaryrefslogtreecommitdiff
path: root/src/lib/ecore_drm/ecore_drm_device.c
diff options
context:
space:
mode:
authorChris Michael <cp.michael@samsung.com>2015-04-08 10:29:29 -0400
committerStefan Schmidt <s.schmidt@samsung.com>2015-04-10 11:09:50 +0200
commit70e8a002718e137bf85f20c6179fa8932fd12083 (patch)
treebbd2efe3f44d73f6ee1fb03697225d8d0e0972f2 /src/lib/ecore_drm/ecore_drm_device.c
parentdb87e02ac6c3ad9595e107951e0fa73c18d0e668 (diff)
ecore-drm: Move doxygen documentation to main Ecore_Drm header
Summary: This moves all doxygen to the main Ecore_Drm header to match rest of efl. @fix Signed-off-by: Chris Michael <cp.michael@samsung.com>
Diffstat (limited to 'src/lib/ecore_drm/ecore_drm_device.c')
-rw-r--r--src/lib/ecore_drm/ecore_drm_device.c113
1 files changed, 0 insertions, 113 deletions
diff --git a/src/lib/ecore_drm/ecore_drm_device.c b/src/lib/ecore_drm/ecore_drm_device.c
index b0f7953ae6..275c9d0d3e 100644
--- a/src/lib/ecore_drm/ecore_drm_device.c
+++ b/src/lib/ecore_drm/ecore_drm_device.c
@@ -105,18 +105,6 @@ _ecore_drm_device_cb_output_event(const char *device EINA_UNUSED, Eeze_Udev_Even
105 * the DRM device itself. 105 * the DRM device itself.
106 */ 106 */
107 107
108/**
109 * Find a drm device in the system.
110 *
111 * @param name The name of the device to find. If NULL, this function will
112 * search for the default drm device.
113 * @param seat The name of the seat where this device may be found. If NULL,
114 * this function will use a default seat name 'seat0'.
115 *
116 * @return An opaque Ecore_Drm_Device structure representing the card.
117 *
118 * @ingroup Ecore_Drm_Device_Group
119 */
120EAPI Ecore_Drm_Device * 108EAPI Ecore_Drm_Device *
121ecore_drm_device_find(const char *name, const char *seat) 109ecore_drm_device_find(const char *name, const char *seat)
122{ 110{
@@ -215,15 +203,6 @@ out:
215 return dev; 203 return dev;
216} 204}
217 205
218/**
219 * Free an Ecore_Drm_Device
220 *
221 * This function will cleanup and free any previously allocated Ecore_Drm_Device.
222 *
223 * @param dev The Ecore_Drm_Device to free
224 *
225 * @ingroup Ecore_Drm_Device_Group
226 */
227EAPI void 206EAPI void
228ecore_drm_device_free(Ecore_Drm_Device *dev) 207ecore_drm_device_free(Ecore_Drm_Device *dev)
229{ 208{
@@ -266,17 +245,6 @@ ecore_drm_device_free(Ecore_Drm_Device *dev)
266 free(dev); 245 free(dev);
267} 246}
268 247
269/**
270 * Open an Ecore_Drm_Device
271 *
272 * This function will open an existing Ecore_Drm_Device for use.
273 *
274 * @param dev The Ecore_Drm_Device to try and open
275 *
276 * @return EINA_TRUE on success, EINA_FALSE on failure
277 *
278 * @ingroup Ecore_Drm_Device_Group
279 */
280EAPI Eina_Bool 248EAPI Eina_Bool
281ecore_drm_device_open(Ecore_Drm_Device *dev) 249ecore_drm_device_open(Ecore_Drm_Device *dev)
282{ 250{
@@ -342,17 +310,6 @@ ecore_drm_device_open(Ecore_Drm_Device *dev)
342 return EINA_TRUE; 310 return EINA_TRUE;
343} 311}
344 312
345/**
346 * Close an Ecore_Drm_Device
347 *
348 * This function will close a previously opened Ecore_Drm_Device
349 *
350 * @param dev The Ecore_Drm_Device to free
351 *
352 * @return EINA_TRUE on success, EINA_FALSE on failure
353 *
354 * @ingroup Ecore_Drm_Device_Group
355 */
356EAPI Eina_Bool 313EAPI Eina_Bool
357ecore_drm_device_close(Ecore_Drm_Device *dev) 314ecore_drm_device_close(Ecore_Drm_Device *dev)
358{ 315{
@@ -382,17 +339,6 @@ ecore_drm_devices_get(void)
382 return drm_devices; 339 return drm_devices;
383} 340}
384 341
385/**
386 * Get if a given Ecore_Drm_Device is master
387 *
388 * This function will check if the given drm device is set to master
389 *
390 * @param dev The Ecore_Drm_Device to check
391 *
392 * @return EINA_TRUE if device is master, EINA_FALSE otherwise
393 *
394 * @ingroup Ecore_Drm_Device_Group
395 */
396EAPI Eina_Bool 342EAPI Eina_Bool
397ecore_drm_device_master_get(Ecore_Drm_Device *dev) 343ecore_drm_device_master_get(Ecore_Drm_Device *dev)
398{ 344{
@@ -409,17 +355,6 @@ ecore_drm_device_master_get(Ecore_Drm_Device *dev)
409 return EINA_FALSE; 355 return EINA_FALSE;
410} 356}
411 357
412/**
413 * Set a given Ecore_Drm_Device to master
414 *
415 * This function will attempt to set a given drm device to be master
416 *
417 * @param dev The Ecore_Drm_Device to set
418 *
419 * @return EINA_TRUE on success, EINA_FALSE on failure
420 *
421 * @ingroup Ecore_Drm_Device_Group
422 */
423EAPI Eina_Bool 358EAPI Eina_Bool
424ecore_drm_device_master_set(Ecore_Drm_Device *dev) 359ecore_drm_device_master_set(Ecore_Drm_Device *dev)
425{ 360{
@@ -433,17 +368,6 @@ ecore_drm_device_master_set(Ecore_Drm_Device *dev)
433 return EINA_TRUE; 368 return EINA_TRUE;
434} 369}
435 370
436/**
437 * Tell a given Ecore_Drm_Device to stop being master
438 *
439 * This function will attempt to ask a drm device to stop being master
440 *
441 * @param dev The Ecore_Drm_Device to set
442 *
443 * @return EINA_TRUE on success, EINA_FALSE on failure
444 *
445 * @ingroup Ecore_Drm_Device_Group
446 */
447EAPI Eina_Bool 371EAPI Eina_Bool
448ecore_drm_device_master_drop(Ecore_Drm_Device *dev) 372ecore_drm_device_master_drop(Ecore_Drm_Device *dev)
449{ 373{
@@ -457,18 +381,6 @@ ecore_drm_device_master_drop(Ecore_Drm_Device *dev)
457 return EINA_TRUE; 381 return EINA_TRUE;
458} 382}
459 383
460/**
461 * Get the file descriptor of Ecore_Drm_Device
462 *
463 * This function will get the file descriptor of drm device
464 *
465 * @param dev The Ecore_Drm_Device to get
466 *
467 * @return fd value on success, -1 on failure
468 *
469 * @ingroup Ecore_Drm_Device_Group
470 *
471 */
472EAPI int 384EAPI int
473ecore_drm_device_fd_get(Ecore_Drm_Device *dev) 385ecore_drm_device_fd_get(Ecore_Drm_Device *dev)
474{ 386{
@@ -476,18 +388,6 @@ ecore_drm_device_fd_get(Ecore_Drm_Device *dev)
476 return dev->drm.fd; 388 return dev->drm.fd;
477} 389}
478 390
479/**
480 * Set the window of Ecore_Drm_Device
481 *
482 * This function will set the window for given drm device
483 *
484 * @param dev The Ecore_Drm_Device for which window is set
485 * @param window The window to set
486 *
487 * @ingroup Ecore_Drm_Device_Group
488 *
489 * @since 1.10
490 */
491EAPI void 391EAPI void
492ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window) 392ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window)
493{ 393{
@@ -497,19 +397,6 @@ ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window)
497 dev->window = window; 397 dev->window = window;
498} 398}
499 399
500/**
501 * Get the name of the Ecore_Drm_Device
502 *
503 * This function will return the name of Ecore_Drm_Device
504 *
505 * @param dev The Ecore_Drm_Device to get name
506 *
507 * @return device name on success, NULL on failure
508 *
509 * @ingroup Ecore_Drm_Device_Group
510 *
511 * @since 1.10
512 */
513EAPI const char * 400EAPI const char *
514ecore_drm_device_name_get(Ecore_Drm_Device *dev) 401ecore_drm_device_name_get(Ecore_Drm_Device *dev)
515{ 402{