client: documetation for voutput

Change-Id: Icf6ebcb1a06ea4deff25e092143d769eab5514ab
Signed-off-by: Junkyeong Kim <jk0430.kim@samsung.com>

diff --git a/client/tdm_client.h b/client/tdm_client.h
index f8b2dec..7f5d247 100644 (file)
--- a/client/tdm_client.h
+++ b/client/tdm_client.h
@@ -440,43 +440,115 @@ unsigned int
 tdm_client_vblank_is_waiting(tdm_client_vblank *vblank);
 
 
-/* Virtual Output */
+/**
+ * @brief Create the client voutput object which has the given name
+ * @param[in] client The TDM client object
+ * @param[in] name The name of the TDM client virtual output object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A client voutput object if success. Otherwise, NULL.
+ */
 tdm_client_voutput *
 tdm_client_create_voutput(tdm_client *client, const char *name, tdm_error *error);
 
+/**
+ * @brief Destroy the client voutput object
+ * @param[in] voutput The client voutput object
+ */
 void
 tdm_client_voutput_destroy(tdm_client_voutput *voutput);
 
+/**
+ * @brief Set the available mode info to the client voutput object
+ * @param[in] voutput The client voutput object
+ * @param[in] modes The array of available mode info
+ * @param[in] count The mode count
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
 tdm_error
 tdm_client_voutput_set_available_modes(tdm_client_voutput *voutput, const tdm_client_output_mode *modes, int count);
 
+/**
+ * @brief Set the physical size info to the client voutput object
+ * @param[in] voutput The client voutput object
+ * @param[in] mmWidth The width of voutput
+ * @param[in] mmHeight The height of voutput
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
 tdm_error
 tdm_client_voutput_set_physical_size(tdm_client_voutput *voutput, unsigned int mmWidth, unsigned int mmHeight);
 
+/**
+ * @brief Set the client voutput buffer commit handler
+ * @details The handler will be called when server send buffer.
+ * Client can get the committed buffer in the handler function.
+ * @param[in] voutput The client voutput object
+ * @param[in] func The user client voutput buffer commit handler
+ * @param[in] user_data The user_data
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
 tdm_error
 tdm_client_voutput_add_commit_handler(tdm_client_voutput *voutput, tdm_client_voutput_commit_handler func, void *user_data);
 
+/**
+ * @brief Remove the client voutput buffer commit handler
+ * @param[in] voutput The client voutput object
+ * @param[in] func The user client voutput buffer commit handler
+ * @param[in] user_data The user_data
+ */
 void
 tdm_client_voutput_remove_commit_handler(tdm_client_voutput *voutput, tdm_client_voutput_commit_handler func, void *user_data);
 
-tdm_error
-tdm_client_voutput_get_committed_tbm_surface(tdm_client_voutput *voutput, tbm_surface_h surface);
-
+/**
+ * @brief Send the commit done event to server
+ * @details
+ * After using the commited buffer which is get from commit handler
+ * have to send done event to server.
+ * @param[in] voutput The client voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
 tdm_error
 tdm_client_voutput_commit_done(tdm_client_voutput *voutput);
 
+/**
+ * @brief Get the client output object which was created by the given voutput object
+ * @details
+ * The client output object is made by voutput object.
+ * @param[in] voutput The client voutput object
+ * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
+ * @return A client output object if success. Otherwise, NULL.
+ */
 tdm_client_output *
 tdm_client_voutput_get_client_output(tdm_client_voutput *voutput, tdm_error *error);
 
+/**
+ * @brief Set the mode to the client voutput object
+ * details
+ * The client can set the mode of voutput object by send mode index.
+ * the index is the array number of available modes info.
+ * @param[in] voutput The client voutput object
+ * @param[in] modes The array of available mode info
+ * @param[in] index The index of avaliable modes
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
 tdm_error
 tdm_client_voutput_set_mode(tdm_client_voutput *voutput, int index);
 
+/**
+ * @brief Set the client voutput object connected status
+ * @detail Send availabe_modes, physical size and connect info to the server.
+ * @param[in] voutput The client voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
 tdm_error
 tdm_client_voutput_connect(tdm_client_voutput *voutput);
 
+/**
+ * @brief Set the client voutput object disconnected status
+ * @param[in] voutput The client voutput object
+ * @return #TDM_ERROR_NONE if success. Otherwise, error value.
+ */
 tdm_error
 tdm_client_voutput_disconnect(tdm_client_voutput *voutput);
-/* End of Virtual Output */
 
 #ifdef __cplusplus
 }