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>

1 files changed, 231 insertions, 0 deletions

diff --git a/src/lib/ecore_drm/Ecore_Drm.h b/src/lib/ecore_drm/Ecore_Drm.h
index 9c29505b5d..8d1320e8f2 100644
--- a/src/lib/ecore_drm/Ecore_Drm.h
+++ b/src/lib/ecore_drm/Ecore_Drm.h
@@ -201,15 +201,137 @@ EAPI extern int ECORE_DRM_EVENT_SEAT_ADD; /**< @since 1.14 */
 EAPI int ecore_drm_init(void);
 EAPI int ecore_drm_shutdown(void);
 
+/**
+ * Find a drm device in the system.
+ *
+ * @param name The name of the device to find. If NULL, this function will 
+ *             search for the default drm device.
+ * @param seat The name of the seat where this device may be found. If NULL, 
+ *             this function will use a default seat name 'seat0'.
+ * 
+ * @return An opaque Ecore_Drm_Device structure representing the card.
+ * 
+ * @ingroup Ecore_Drm_Device_Group
+ */
 EAPI Ecore_Drm_Device *ecore_drm_device_find(const char *name, const char *seat);
+
+/**
+ * Free an Ecore_Drm_Device
+ *
+ * This function will cleanup and free any previously allocated Ecore_Drm_Device.
+ * 
+ * @param dev The Ecore_Drm_Device to free
+ * 
+ * @ingroup Ecore_Drm_Device_Group
+ */
 EAPI void ecore_drm_device_free(Ecore_Drm_Device *dev);
+
+/**
+ * Open an Ecore_Drm_Device
+ *
+ * This function will open an existing Ecore_Drm_Device for use.
+ * 
+ * @param dev The Ecore_Drm_Device to try and open
+ * 
+ * @return EINA_TRUE on success, EINA_FALSE on failure
+ * 
+ * @ingroup Ecore_Drm_Device_Group
+ */
 EAPI Eina_Bool ecore_drm_device_open(Ecore_Drm_Device *dev);
+
+/**
+ * Close an Ecore_Drm_Device
+ *
+ * This function will close a previously opened Ecore_Drm_Device
+ * 
+ * @param dev The Ecore_Drm_Device to free
+ * 
+ * @return EINA_TRUE on success, EINA_FALSE on failure
+ * 
+ * @ingroup Ecore_Drm_Device_Group
+ */
 EAPI Eina_Bool ecore_drm_device_close(Ecore_Drm_Device *dev);
+
+/**
+ * Get if a given Ecore_Drm_Device is master
+ * 
+ * This function will check if the given drm device is set to master
+ * 
+ * @param dev The Ecore_Drm_Device to check
+ * 
+ * @return EINA_TRUE if device is master, EINA_FALSE otherwise
+ * 
+ * @ingroup Ecore_Drm_Device_Group
+ */
 EAPI Eina_Bool ecore_drm_device_master_get(Ecore_Drm_Device *dev);
+
+/**
+ * Set a given Ecore_Drm_Device to master
+ * 
+ * This function will attempt to set a given drm device to be master
+ * 
+ * @param dev The Ecore_Drm_Device to set
+ * 
+ * @return EINA_TRUE on success, EINA_FALSE on failure
+ * 
+ * @ingroup Ecore_Drm_Device_Group
+ */
 EAPI Eina_Bool ecore_drm_device_master_set(Ecore_Drm_Device *dev);
+
+/**
+ * Tell a given Ecore_Drm_Device to stop being master
+ * 
+ * This function will attempt to ask a drm device to stop being master
+ * 
+ * @param dev The Ecore_Drm_Device to set
+ * 
+ * @return EINA_TRUE on success, EINA_FALSE on failure
+ * 
+ * @ingroup Ecore_Drm_Device_Group
+ */
 EAPI Eina_Bool ecore_drm_device_master_drop(Ecore_Drm_Device *dev);
+
+/**
+ * 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);
+
+/**
+ * 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 ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window);
+
+/**
+ * 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 *ecore_drm_device_name_get(Ecore_Drm_Device *dev);
 
 /**
@@ -226,15 +348,105 @@ EAPI const char *ecore_drm_device_name_get(Ecore_Drm_Device *dev);
  */
 EAPI Eina_Bool ecore_drm_device_software_setup(Ecore_Drm_Device *dev);
 
+/**
+ * Open a tty for use
+ * 
+ * @param dev  The Ecore_Drm_Device that this tty will belong to.
+ * @param name The name of the tty to try and open. 
+ *             If NULL, /dev/tty0 will be used.
+ * 
+ * @return     EINA_TRUE on success, EINA_FALSE on failure
+ * 
+ * @ingroup Ecore_Drm_Tty_Group
+ */
 EAPI Eina_Bool ecore_drm_tty_open(Ecore_Drm_Device *dev, const char *name);
+
+/**
+ * Close an already opened tty
+ * 
+ * @param dev The Ecore_Drm_Device which owns this tty.
+ * 
+ * @return    EINA_TRUE on success, EINA_FALSE on failure
+ * 
+ * @ingroup Ecore_Drm_Tty_Group
+ */
 EAPI Eina_Bool ecore_drm_tty_close(Ecore_Drm_Device *dev);
+
+/**
+ * Release a virtual terminal
+ * 
+ * @param dev The Ecore_Drm_Device which owns this tty.
+ * 
+ * @return    EINA_TRUE on success, EINA_FALSE on failure
+ * 
+ * @ingroup Ecore_Drm_Tty_Group
+ */
 EAPI Eina_Bool ecore_drm_tty_release(Ecore_Drm_Device *dev);
+
+/**
+ * Acquire a virtual terminal
+ * 
+ * @param dev The Ecore_Drm_Device which owns this tty.
+ * 
+ * @return    EINA_TRUE on success, EINA_FALSE on failure
+ * 
+ * @ingroup Ecore_Drm_Tty_Group
+ */
 EAPI Eina_Bool ecore_drm_tty_acquire(Ecore_Drm_Device *dev);
+
+/**
+ * Get the opened virtual terminal file descriptor
+ * 
+ * @param dev The Ecore_Drm_Device which owns this tty.
+ * 
+ * @return    The tty fd opened from previous call to ecore_drm_tty_open
+ * 
+ * @ingroup Ecore_Drm_Tty_Group
+ * 
+ * @since 1.10
+ */
 EAPI int ecore_drm_tty_get(Ecore_Drm_Device *dev);
 
+/**
+ * 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);
+
+/**
+ * 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);
+
+/**
+ * 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);
+
+/* TODO: Doxy */
 EAPI Eina_Bool ecore_drm_output_enable(Ecore_Drm_Output *output);
 
 /**
@@ -248,15 +460,34 @@ EAPI Eina_Bool ecore_drm_output_enable(Ecore_Drm_Output *output);
  * @since 1.15
  */
 EAPI void ecore_drm_output_disable(Ecore_Drm_Output *output);
+
+/* TODO: Doxy */
 EAPI void ecore_drm_output_fb_release(Ecore_Drm_Output *output, Ecore_Drm_Fb *fb);
+
+/* TODO: Doxy */
 EAPI void ecore_drm_output_repaint(Ecore_Drm_Output *output);
+
+/**
+ * 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);
 
 /**
+ * TODO: Doxy
  * @since 1.12
  */
 EAPI void ecore_drm_outputs_geometry_get(Ecore_Drm_Device *dev, int *x, int *y, int *w, int *h);
 
+/* TODO: Doxy */
 EAPI Eina_Bool ecore_drm_inputs_create(Ecore_Drm_Device *dev);
 EAPI void ecore_drm_inputs_destroy(Ecore_Drm_Device *dev);
 EAPI Eina_Bool ecore_drm_inputs_enable(Ecore_Drm_Input *input);