package version up to 2.8.0

[platform/core/uifw/libtbm.git] / src / tbm_drm_helper.h

diff --git a/src/tbm_drm_helper.h b/src/tbm_drm_helper.h
index 77f97ce..97b240c 100644 (file)
--- a/src/tbm_drm_helper.h
+++ b/src/tbm_drm_helper.h
@@ -58,40 +58,33 @@ int tbm_drm_helper_wl_auth_server_init(void  *wl_display, int fd, const char *de
 void tbm_drm_helper_wl_auth_server_deinit(void);
 
 /**
- * @brief Get a fd from the specific enviroment variable.
+ * @brief Get a drm master fd.
  * @details
- * This function will dup the fd of the given enviroment variable.
+ * This function will dup the drm master fd.
    The Caller SHOULD close the fd.
-   In DRM system, a drm-master-fd SHOULD be shared between TDM backend and
-   TBM backend in display server side by using "TDM_DRM_MASTER_FD" and "TBM_DRM_MASTER_FD".
- * @param[in] env The given enviroment variable
+   In DRM system, a drm master fd SHOULD be shared between TDM backend and
+   TBM backend in display server side.
  * @return fd if success. Otherwise, -1.
- * @see #tdm_helper_set_tbm_master_fd()
+ * @see #tbm_drm_helper_set_tbm_master_fd()
+ * @see #tbm_drm_helper_unset_tbm_master_fd()
  */
 int  tbm_drm_helper_get_master_fd(void);
 
 /**
- * @brief Set the given fd to TBM_DRM_MASTER_FD enviroment variable.
+ * @brief Set a drm master fd with the given fd.
  * @details
- * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
-   TBM backend in display server side by using "TDM_DRM_MASTER_FD"
-   and "TBM_DRM_MASTER_FD".
+ * In DRM system, a drm master fd @b SHOULD be shared between TDM backend and
+   TBM backend in display server side.
  * @param[in] fd The given fd
- * @see #tdm_helper_set_tbm_master_fd()
+ * @see #tbm_drm_helper_get_master_fd()
  * @see #tbm_drm_helper_unset_tbm_master_fd()
  */
 void tbm_drm_helper_set_tbm_master_fd(int fd);
 
 /**
- * @brief Unset the TBM_DRM_MASTER_FD enviroment variable.
- * @details
- * In DRM system, a drm-master-fd @b SHOULD be shared between TDM backend and
-   TBM backend in display server side by using "TDM_DRM_MASTER_FD"
-   and "TBM_DRM_MASTER_FD".
- * @param[in] env The given enviroment variable
- * @param[in] fd The given fd
- * @see #tdm_helper_set_tbm_master_fd()
- * @see #tbm_drm_helper_unset_tbm_master_fd()
+ * @brief Unset a drm master fd.
+ * @see #tbm_drm_helper_get_master_fd()
+ * @see #tbm_drm_helper_set_tbm_master_fd()
  */
 void tbm_drm_helper_unset_tbm_master_fd(void);
 
@@ -110,7 +103,7 @@ void tbm_drm_helper_unset_tbm_master_fd(void);
 int tbm_drm_helper_get_auth_info(int *auth_fd, char **device, uint32_t *capabilities);
 
 /**
- * @brief Set the given fd to TBM_DRM_FD enviroment variable.
+ * @brief Set drm fd with the given fd.
  * @details
  * Some client want to get drm fd used tbm_backend.
    if tbm_backend allow that client use drm_fd, it SHOULD be set.
@@ -120,7 +113,7 @@ int tbm_drm_helper_get_auth_info(int *auth_fd, char **device, uint32_t *capabili
 void tbm_drm_helper_set_fd(int fd);
 
 /**
- * @brief Unset the given fd to TBM_DRM_FD enviroment variable.
+ * @brief Unset drm fd.
  * @details
  * Some client want to get drm fd used tbm_backend.
    if tbm_backend allow that client use drm_fd, it SHOULD be set.
@@ -130,7 +123,7 @@ void tbm_drm_helper_set_fd(int fd);
 void tbm_drm_helper_unset_fd(void);
 
 /**
- * @brief Get the fd from TBM_DRM_FD enviroment variable.
+ * @brief Get drm fd.
  * @details
  * Some client want to get drm fd used tbm_backend.
    client can get drm fd from this fucntion.