Remove descriptions of APIs

Change-Id: Ibb6c60daa50685d43cd09cb4e8dc7298e18811a9
Signed-off-by: Hwankyu Jhun <h.jhun@samsung.com>

diff --git a/include/tizen_core.h b/include/tizen_core.h
index dd74f4b3fd3c981fa4927c7dd310771ca831183d..edd888b6eabeaefa242bf420995d2b4e0df2c33a 100644 (file)
--- a/include/tizen_core.h
+++ b/include/tizen_core.h
@@ -29,648 +29,134 @@
 extern "C" {
 #endif
 
-/**
- * @brief Enumeration for the tizen core result.
- * @since_tizen 9.0
- */
 typedef enum {
-  TIZEN_CORE_ERROR_NONE = TIZEN_ERROR_NONE,  /**< Successful */
-  TIZEN_CORE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER,  /**< Invalid parameter */
-  TIZEN_CORE_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY,  /**< Out of memory */
-  TIZEN_CORE_ERROR_INVALID_CONTEXT = TIZEN_ERROR_APPLICATION | 0x01,  /**< Invalid context */
+  TIZEN_CORE_ERROR_NONE = TIZEN_ERROR_NONE,
+  TIZEN_CORE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER,
+  TIZEN_CORE_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY,
+  TIZEN_CORE_ERROR_INVALID_CONTEXT = TIZEN_ERROR_APPLICATION | 0x01,
 } tizen_core_error_e;
 
-/**
- * @brief Enumberation for the priority of tizen core source.
- * @since_tizen 9.0
- */
 typedef enum {
-  TIZEN_CORE_PRIORITY_HIGH = -100,  /**< High priority */
-  TIZEN_CORE_PRIORITY_DEFAULT = 0,  /**< Default priority */
-  TIZEN_CORE_PRIORITY_HIGH_IDLE = 100,  /**< High idle priority */
-  TIZEN_CORE_PRIORITY_DEFAULT_IDLE = 200,  /**< Default idle priority */
-  TIZEN_CORE_PRIORITY_LOW = 300,  /**< Low priority */
+  TIZEN_CORE_PRIORITY_HIGH = -100,
+  TIZEN_CORE_PRIORITY_DEFAULT = 0,
+  TIZEN_CORE_PRIORITY_HIGH_IDLE = 100,
+  TIZEN_CORE_PRIORITY_DEFAULT_IDLE = 200,
+  TIZEN_CORE_PRIORITY_LOW = 300,
 } tizen_core_priority_e;
 
-/**
- * @brief The tizen core handle.
- * @since_tizen 9.0
- */
-typedef void *tizen_core_h;
 
+typedef void *tizen_core_h;
 
-/**
- * @brief The tizen core task handle.
- * @since_tizen 9.0
- */
 typedef void *tizen_core_task_h;
 
-/**
- * @brief The tizen core source handle.
- * @since_tizen 9.0
- */
 typedef void *tizen_core_source_h;
 
-/**
- * @brief The tizen core poll fd handle.
- * @since_tizen 9.0
- */
 typedef void *tizen_core_poll_fd_h;
 
-/**
- * @brief Called when the tizen core idle or timer event is emitted.
- * @since_tizen 9.0
- *
- * @param[in] user_data The user data passed from the callback registration function
- * @return @c true to repeat calling the callback function,
- *         otherwise @c false to remove the added source.
- * @see tizen_core_add_idle_job()
- * @see tizen_core_add_timer()
- */
 typedef bool (*tizen_core_cb)(void *user_data);
 
-/**
- * @brief Called when checks whether the source is ready to be processed or not.
- * @since_tizen 9.0
- * @details The function returns a timeout value to ensuare that the poll()
- *          call doesn't block too long and miss the next timeout.
- *          The timeout value is -1 to indicate that it doesn't mind how long
- *          the poll() call blocks.
- *
- * @param[in] source The tizen core source handle
- * @param[out] timeout The timeout
- * @param[in] user_data The user data passed from the callback registration function
- * @return @c true to indicate that the source is always ready to be processed,
- *         otherwise @c false to wait until poll() has been called before it knows whether any events need to be processed.
- * @see tizen_core_source_set_prepare_callback()
- */
 typedef bool (*tizen_core_source_prepare_cb)(tizen_core_source_h source,
                                              int *timeout, void *user_data);
 
-/**
- * @brief Called when checks whether the source is ready to be processed or not.
- * @since_tizen 9.0
- *
- * @param[in] source The tizen core source handle
- * @param[in] user_data The user data passed from the callback registration function
- * @return @c true to indicate that the source is always ready to be processed,
- *         otherwise @c false to indicate that the source is not ready to be processed.
- * @see tizen_core_source_set_check_callback()
- */
 typedef bool (*tizen_core_source_check_cb)(tizen_core_source_h source,
                                            void *user_data);
 
-/**
- * @brief Called when dispatches events.
- * @since_tizen 9.0
- *
- * @param[in] source The tizen core source handle
- * @param[in] user_data The user data passed from the callback registration function
- * @return @c true to indicate that the process is ready to dispatch the event.
- * @see tizen_core_source_set_dispatch_callback()
- */
 typedef bool (*tizen_core_source_dispatch_cb)(tizen_core_source_h source,
                                               void *user_data);
 
-/**
- * @brief Called when the source is finalizing.
- * @since_tizen 9.0
- *
- * @param[in] source The tizen core source handle
- * @param[in] user_data The user data passed from the callback registration function
- * @see tizen_core_source_set_finalize_callback()
- */
 typedef void (*tizen_core_source_finalize_cb)(tizen_core_source_h source,
                                               void *user_data);
 
-/**
- * @brief Initializes the tizen core.
- * @since_tizen 9.0
- *
- * @return @c a positive return value on success,
- *         otherwise a negative error value
- * @see tizen_core_fini()
- * @see tizen_core_ready()
- */
 int tizen_core_init(void);
 
-/**
- * @brief Finalizes the tizen core.
- * @since_tizen 9.0
- *
- * @return @c a positive return value or @c 0.
- * @see tizen_core_init()
- * @see tizen_core_ready()
- */
 int tizen_core_fini(void);
 
-/**
- * @brief Checks whether the tizen core is ready or not.
- * @since_tizen 9.0
- *
- * @return @c true if the tizen core is ready, otherwise @c false.
- * @see tizen_core_init()
- * @see tizen_core_fini()
- */
 bool tizen_core_ready(void);
 
-/**
- * @brief Creates the tizen core task handle.
- * @since_tizen 9.0
- *
- * @param[in] name The name of the task
- * @param[in] use_thread true, if the task should be run in a separate thread, otherwise @c false
- * @param[out] h The tizen core task handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #TIZEN_CORE_ERROR_INVALID_CONTEXT Invalid context
- * @see tizen_core_task_destroy()
- */
 int tizen_core_task_create(const char *name, bool use_thread,
                            tizen_core_task_h *h);
 
-/**
- * @brief Destroys the tizen core task handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core task handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_task_create()
- */
 int tizen_core_task_destroy(tizen_core_task_h h);
 
-/**
- * @brief Runs the main loop of the tizen core task.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core task handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_task_quit()
- */
 int tizen_core_task_run(tizen_core_task_h h);
 
-/**
- * @brief Checks whether the tizen core task is running or not.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core task handle
- * @return @c true if the core task is running,
- *         otherwise @c false
- * @see tizen_core_task_run()
- * @see tizen_core_task_quit()
- */
 bool tizen_core_task_is_running(tizen_core_task_h h);
 
-/**
- * @brief Exits the main loop of the tizen_core task.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core task handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE__ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_task_quit()
- */
 int tizen_core_task_quit(tizen_core_task_h h);
 
-/**
- * @brief Gets the tizen_core from the tizen_core task handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core task handle
- * @param[out] core The tizen_core handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- */
 int tizen_core_task_get_tizen_core(tizen_core_task_h h, tizen_core_h *core);
 
-/**
- * @brief Finds the tizen core from the name.
- * @since_tizen 9.0
- *
- * @param[in] name The tizen core task name
- * @param[out] h The tizen core handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- */
 int tizen_core_find(const char *name, tizen_core_h *h);
 
-/**
- * @brief the tizen core from this thread.
- * @since_tizen 9.0
- *
- * @param[out] h The tizen core handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- */
 int tizen_core_find_from_this_thread(tizen_core_h *h);
 
-/**
- * @brief Adds an idle job to the tizen core.
- * @since_tizen 9.0
- * @details The callback function will be called whenever there are
- *          no higher priority events pending to the tizen_core.
- *          The given callback function is called repeatedly until it returns false,
- *          at which point the idler is automatically destroyed and the callback function
- *          will not be called again.
- *
- * @param[in] h The tizen_core handle
- * @param[in] callback The callback function to be invoked when the idle job is emitted
- * @param[in] user_data The user data to be passed to the callback function
- * @return @c the tizen_core source handle on success,
- *         otherwise a nullptr
- * @see tizen_core_remove_source()
- */
 tizen_core_source_h tizen_core_add_idle_job(tizen_core_h h,
                                             tizen_core_cb callback,
                                             void *user_data);
 
-/**
- * @brief Adds a timer to the tizen core.
- * @since_tizen 9.0
- * @details The callback function will be called at regular intervals.
- *          The given callback function is called repeatedly until it returns false,
- *          at which point the timeout is automatically destroyed and the callback function
- *          will not be called again.
- *
- * @param[in] h The tizen_core handle
- * @param[in] interval The interval of the timer in milliseconds
- * @param[in] callback The callback function to be invoked when the timer is expired
- * @param[in] user_data The user data to be passed to the callback function
- * @return @c the tizen_core source handle on success,
- *         otherwise a nullptr
- * @see tizen_core_remove_source()
- */
 tizen_core_source_h tizen_core_add_timer(tizen_core_h h, unsigned int interval,
                                tizen_core_cb callback, void *user_data);
 
-/**
- * @brief Adds a channel receiver to the tizen core.
- * @since_tizen 9.0
- * @details The callback function will be called when the channel event is received.
- *
- * @param[in] h The tizen core handle
- * @param[in] receiver The channel receiver handle
- * @param[in] callback The callback function to be invoked when the channel event is received
- * @param[in] user_data The user data to be passed to the callback function
- * @return @c the tizen_core source handle on success,
- *         otherwise a nullptr
- * @see tizen_core_remove_source()
- */
 tizen_core_source_h tizen_core_add_channel(
     tizen_core_h h, tizen_core_channel_receiver_h receiver,
     tizen_core_channel_cb callback, void *user_data);
 
-/**
- * @brief Adds an event to the tizen core.
- * @since_tizen 9.0
- * @details The event handler added to the event handle is called
- *          using the corresponding core loop when the event emit occurs.
- *
- * @param[in] h The tize core handle
- * @param[in] event The tizen core event handle
- * @return @c the tizen core source handle on success,
- *         otherwise a nullptr
- * @see tizen_core_remove_source()
- */
 tizen_core_source_h tizen_core_add_event(tizen_core_h h,
                                          tizen_core_event_h event);
 
-/**
- * @brief Emits the event to the tizen core.
- * @since_tizen 9.0
- * @details The event is emitted to the event handler registered in the corresponding tizen_core.
- *
- * @param[in] h The tizen core handle
- * @param[in] object The tizen core event object handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_add_event()
- */
 int tizen_core_emit_event(tizen_core_h h, tizen_core_event_object_h object);
 
-/**
- * @brief Adds a source to the tizen core.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core handle
- * @param[in] source The tizen core source handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_RRROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_add_source()
- */
 int tizen_core_add_source(tizen_core_h h, tizen_core_source_h source);
 
-/**
- * @brief Removes the source from the tizen core.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core handle
- * @param[in] source The tizen core source handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_add_source()
- */
 int tizen_core_remove_source(tizen_core_h h, tizen_core_source_h source);
 
-/**
- * @brief Creates a tizen core source handle.
- * @since_tizen 9.0
- *
- * @param[out] h The tizen core source handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #TIZEN_CORE_ERROR_INVALID_CONTEXT Invalid context
- * @see tizen_core_add_source()
- * @see tizen_core_remove_source()
- * @see tizen_core_source_destroy()
- */
 int tizen_core_source_create(tizen_core_source_h *h);
 
-/**
- * @brief Destroys the tizen core source handle.
- * @since_tizen 9.0
- * @remarks If the handle is already added to the tizen core using the tizen_core_add_source(),
- *          the source must be released using the tizen core_remove_source().
- *
- * @param[in] h The tizen core source handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_source_create()
- * @see tizen_core_remove_source()
- */
 int tizen_core_source_destroy(tizen_core_source_h h);
 
-/**
- * @brief Waits for some events on the file descriptor.
- * @since_tizen 9.0
- * @details The tizen core source must be created using the tizen_core_source_create().
- *
- * @param[in] h The tizen core source handle
- * @param[in] poll_fd The poll fd handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_INVALID_CONTEXT Invalid context
- * @see tizen_core_source_create()
- * @see tizen_core_source_set_prepare_callback()
- * @see tizen_core_source_set_check_callback()
- * @see tizen_core_source_set_dispatch_callback()
- * @see tizen_core_source_set_finalize_callback()
- * @see tizen_core_source_remove_poll()
- */
 int tizen_core_source_add_poll(tizen_core_source_h h,
                                tizen_core_poll_fd_h poll_fd);
 
-/**
- * @brief Removes to waits for some events on the file descriptor.
- * @since_tizen 9.0
- * @details The tizen core source must be created using the tizen_core_source_create().
- *
- * @param[in] h The tizen core source handle
- * @param[in] poll_fd The poll fd handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_INVALID_CONTEXT Invalid context
- * @see tizen_core_source_add_poll()
- */
 int tizen_core_source_remove_poll(tizen_core_source_h h,
                                   tizen_core_poll_fd_h poll_fd);
 
-/**
- * @brief Sets the prepare callback function to the tizen core source.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core source handle
- * @param[in] callback The callback function to be invoked when the source is ready to be processed
- * @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_source_add_poll()
- */
 int tizen_core_source_set_prepare_callback(
     tizen_core_source_h h, tizen_core_source_prepare_cb callback,
     void *user_data);
 
-/**
- * @brief Sets the check callback function to the tizen core source.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core source handle
- * @param[in] callback The callback function to be invoked when the source is ready to be processed
- * @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_source_add_poll()
- */
 int tizen_core_source_set_check_callback(tizen_core_source_h h,
                                          tizen_core_source_check_cb callback,
                                          void *user_data);
 
-/**
- * @brief Sets the dispatch callback function to the tizen core source.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core source handle
- * @param[in] callback The callback function to be dispatched events
- * @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_source_add_poll()
- */
 int tizen_core_source_set_dispatch_callback(
     tizen_core_source_h h, tizen_core_source_dispatch_cb callback,
     void *user_data);
 
-/**
- * @brief Sets the finalize callback function to the tizen core source.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core source handle
- * @param[in] callback The callback function to finalize the source
- * @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_source_add_poll()
- */
 int tizen_core_source_set_finalize_callback(
     tizen_core_source_h h, tizen_core_source_finalize_cb callback,
     void *user_data);
 
-/**
- * @brief Sets the priority to the tizen core source.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core source handle
- * @param[in] priority The priority value
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_priority_e
- */
 int tizen_core_source_set_priority(tizen_core_source_h h,
                                    tizen_core_priority_e priority);
 
-/**
- * @brief Gets the poll fds from the tizen core source.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core source handle
- * @param[out] poll_fds The polling file descriptors
- * @param[out] length The length of the polling file descriptors
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- * @see tizen_core_source_add_poll()
- */
 int tizen_core_source_get_poll_fds(tizen_core_source_h h,
                                    tizen_core_poll_fd_h *poll_fds,
                                    unsigned int *length);
 
-/**
- * @brief Creates a tizen core poll fd handle.
- * @since_tizen 9.0
- *
- * @param[out] h The tizen core poll fd handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- * @see tizen_core_poll_fd_destroy()
- */
 int tizen_core_poll_fd_create(tizen_core_poll_fd_h *h);
 
-/**
- * @brief Destroys the tizen core poll fd handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core poll fd handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- */
 int tizen_core_poll_fd_destroy(tizen_core_poll_fd_h h);
 
-/**
- * @brief Sets the file descriptor to the poll fd handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core poll fd handle
- * @param[in] fd The file descriptor
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_RRROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_poll_fd_get_fd()
- */
 int tizen_core_poll_fd_set_fd(tizen_core_poll_fd_h h, int fd);
 
-/**
- * @brief Gets the file descriptor from the poll fd handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core poll fd handle
- * @param[out] fd The file descriptor
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_RRROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_poll_fd_set_fd()
- */
 int tizen_core_poll_fd_get_fd(tizen_core_poll_fd_h h, int *fd);
 
-/**
- * @brief Sets the requested events to the poll fd handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core poll fd handle
- * @param[in] events The requested events
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_poll_fd_get_events()
- */
 int tizen_core_poll_fd_set_events(tizen_core_poll_fd_h h, uint16_t events);
 
-/**
- * @brief Gets the requested events from the poll fd handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core poll fd handle
- * @param[out] events The requested events
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_poll_fd_set_events()
- */
 int tizen_core_poll_fd_get_events(tizen_core_poll_fd_h h, uint16_t *events);
 
-/**
- * @brief Sets the returned events to the poll fd handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core poll fd handle
- * @param[in] revents The returned events
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_poll_fd_get_events()
- */
 int tizen_core_poll_fd_set_revents(tizen_core_poll_fd_h h, uint16_t revents);
 
-/**
- * @brief Gets the returned events from the poll fd handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core poll fd handle
- * @param[out] revents The returned events
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_poll_fd_set_events()
- */
 int tizen_core_poll_fd_get_revents(tizen_core_poll_fd_h h, uint16_t *revents);
 
 #ifdef __cplusplus

diff --git a/include/tizen_core_channel.h b/include/tizen_core_channel.h
index 48625f843ca72dac4e1334105abe9a7e7ee4fa64..ad6eeb4e065102849c544a6a89d969f8445f1a50 100644 (file)
--- a/include/tizen_core_channel.h
+++ b/include/tizen_core_channel.h
@@ -21,230 +21,47 @@
 extern "C" {
 #endif
 
-/**
- * @brief The tizen core channel sender handle.
- * @since_tizen 9.0
- */
 typedef void *tizen_core_channel_sender_h;
 
-/**
- * @brief The tizen core channel receiver handle.
- * @since_tizen 9.0
- */
 typedef void *tizen_core_channel_receiver_h;
 
-/**
- * @brief The tizen core channel object handle.
- * @since_tizen 9.0
- */
 typedef void *tizen_core_channel_object_h;
 
-/**
- * @brief Called when the channel object is received.
- * @since_tizen 9.0
- * @remarks The @a obj must not be deallocated by the application.
- *
- * @param[in] obj The tizen_core channel object handle
- * @param[in] user_data The user data passed from the registration function
- * @see tizen_core_add_channel()
- */
 typedef void (*tizen_core_channel_cb)(tizen_core_channel_object_h obj,
                                       void *user_data);
 
-/**
- * @brief Makes a pair of channel sender and receiver.
- * @since_tizen 9.0
- *
- * @param[out] sender The tizen core channel sender handle
- * @param[out] receiver The tizen core channel receiver handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #TIZEN_CORE_ERROR_INVALID_CONTEXT Invalid context
- * @see tizen_core_channel_sender_destroy()
- * @see tizen_core_channel_receiver_destroy()
- */
 int tizen_core_channel_make_pair(tizen_core_channel_sender_h *sender,
                                  tizen_core_channel_receiver_h *receiver);
 
-/**
- * @brief Sends the channel object to the receiver.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core channel sender handle
- * @param[in] obj The tizen core channel object handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_channel_object_create()
- */
 int tizen_core_channel_sender_send(tizen_core_channel_sender_h h,
                                    tizen_core_channel_object_h obj);
 
-/**
- * @brief Destroys the channel sender handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core channel sender handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_channel_make_pair()
- * @see tizen_core_channel_sender_clone()
- */
 int tizen_core_channel_sender_destroy(tizen_core_channel_sender_h h);
 
-/**
- * @brief Creates and returns a copy of the given the h handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core channel sender handle
- * @param[out] cloned_h If successful, a newly created tizen core channel sender handle will be returned
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- * @see tizen_core_channel_sender_destroy()
- */
 int tizen_core_channel_sender_clone(tizen_core_channel_sender_h h,
                                     tizen_core_channel_sender_h *cloned_h);
 
-/**
- * @brief Receives the channel object from the sender.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core channel receiver handle
- * @param[out] obj The tizen core channel object handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- */
 int tizen_core_channel_receiver_receive(tizen_core_channel_receiver_h h,
                                         tizen_core_channel_object_h *obj);
 
-/**
- * @brief Destroys the tizen core channel receiver handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core channel receiver handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_channel_make_pair()
- */
 int tizen_core_channel_receiver_destroy(tizen_core_channel_receiver_h h);
 
-/**
- * @brief Creates the tizen core channel object handle.
- * @since_tizen 9.0
- *
- * @param[out] obj The tizen core channel object handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #TIZEN_CORE_ERROR_INVALID_CONTEXT Invalid context
- * @see tizen_core_channel_object_destroy()
- */
 int tizen_core_channel_object_create(tizen_core_channel_object_h *obj);
 
-/**
- * @brief Destroys the tizen core channel object handle.
- * @since_tizen 9.0
- *
- * @param[h] obj The tizen core channel object handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_channel_object_create()
- */
 int tizen_core_channel_object_destroy(tizen_core_channel_object_h obj);
 
-/**
- * @brief Sets the type to the tizen_core channel object handle.
- * @since_tizen 9.0
- *
- * @param[in] obj The tizen core channel object handle
- * @param[in] type The channel type
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_channel_object_get_type()
- */
 int tizen_core_channel_object_set_type(tizen_core_channel_object_h obj,
                                        int type);
 
-/**
- * @brief Gets the type from the tizen_core channel object handle.
- * @since_tizen 9.0
- *
- * @param[in] obj The tizen core channel object handle
- * @param[out] type The channel type
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_channel_object_set_type()
- */
 int tizen_core_channel_object_get_type(tizen_core_channel_object_h obj,
                                        int *type);
 
-/**
- * @brief Sets the data to the tizen core channel object handle.
- * @since_tizen 9.0
- *
- * @param[in] obj The tizen core channel object handle
- * @param[in] data The channel data
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_channel_object_get_data()
- */
 int tizen_core_channel_object_set_data(tizen_core_channel_object_h obj,
                                        void *data);
 
-/**
- * @brief Gets the data from the tizen core channel object handle.
- * @since_tizen 9.0
- *
- * @param[in] obj The tizen core channel object handle
- * @param[out] data The channel data
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_channel_object_set_data()
- */
 int tizen_core_channel_object_get_data(tizen_core_channel_object_h obj,
                                        void **data);
 
-/**
- * @brief Gets the sender task name from the tizen core channel object handle.
- * @since_tizen 9.0
- * @remarks The @a task_name must not be deallocated by the application.
- *
- * @param[in] obj The tizen core channel object handle
- * @param[out] task_name The sender task name
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_INVALID_CONTEXT Invalid context
- * @see tizen_core_channel_sender_send()
- * @see tizen_core_channel_receiver_receive()
- */
 int tizen_core_channel_object_get_sender_task_name(
     tizen_core_channel_object_h obj, const char **task_name);
 

diff --git a/include/tizen_core_event.h b/include/tizen_core_event.h
index c726cb0587f4b8960c02f11e1177b098fabf15c9..f20f65877919436f62a8386fb9f32504cbe792de 100644 (file)
--- a/include/tizen_core_event.h
+++ b/include/tizen_core_event.h
@@ -23,235 +23,49 @@
 extern "C" {
 #endif
 
-/**
- * @brief The tizen core event handle.
- * @since_tizen 9.0
- */
 typedef void *tizen_core_event_h;
 
-/**
- * @brief The tizen core event object handle.
- * @since_tizen 9.0
- */
 typedef void *tizen_core_event_object_h;
 
-/**
- * @brief The tizen core event handler handle.
- * @since_tizen 9.0
- */
 typedef void *tizen_core_event_handler_h;
 
-/**
- * @brief Called when the event is emitted.
- * @since_tizen 9.0
- * @remarks The @a object must not be deallocated by the application.
- *
- * @param[in] object The tizen core event object handle
- * @param[in] user_data The user data passed from the callback registration function
- * @return @c true to continue with the next iteration of the loop,
- *         otherwise @c false to break out of the loop
- * @see tizen_core_event_add_handler()
- */
 typedef bool (*tizen_core_event_handler_cb)(tizen_core_event_object_h object,
                                             void *user_data);
 
-/**
- * @brief Called when the event object is destroyed.
- * @since_tizen 9.0
- *
- * @param[in] data The data of the event object
- * @param[in] user_data The user data passed from the callback registration function
- * @see tizen_core_event_object_set_on_destroy()
- * @see tizen_core_event_object_destroy()
- */
 typedef void (*tizen_core_event_object_on_destroy_cb)(void *data,
                                                       void *user_data);
 
-/**
- * @brief Creates the tizen core event handle.
- * @since_tizen 9.0
- *
- * @param[out] h The tizen core event handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #TIZEN_CORE_ERROR_INVALID_CONTEXT Invalid context
- * @see tizen_core_event_destroy()
- */
 int tizen_core_event_create(tizen_core_event_h *h);
 
-/**
- * @brief Destroys the tizen core event handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core event handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_event_create()
- */
 int tizen_core_event_destroy(tizen_core_event_h h);
 
-/**
- * @brief Adds the event handler to the tizen core event.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core event handle
- * @param[in] callback The callback function to be invoked when the event is emitted
- * @param[in] user_data The user data to be passed to the callback function
- * @param[out] event_handler The tizen core event handler handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- * @see tizen_core_event_emit()
- * @see tizen_core_emit_event()
- * @see tizen_core_event_remove_handler()
- */
 int tizen_core_event_add_handler(
     tizen_core_event_h h, tizen_core_event_handler_cb callback,
     void *user_data, tizen_core_event_handler_h *event_handler);
 
-/**
- * @brief Prepends the event handler to the tizen core event.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core event handle
- * @param[in] callback The callback function to be invoked when the event is emitted
- * @param[in] user_data The user data to be passed to the callback function
- * @param[out] event_handler The tizen core event handler handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- * @see tizen_core_event_emit()
- * @see tizen_core_emit_event()
- * @see tizen_core_event_remove_handler()
- */
 int tizen_core_event_prepend_handler(
     tizen_core_event_h h, tizen_core_event_handler_cb callback,
     void *user_data, tizen_core_event_handler_h *event_handler);
 
-/**
- * @brief Removes the event handler from the tizen core event.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core event handle
- * @param[in] event_handler The tizen core event handler handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_event_add_handler()
- */
 int tizen_core_event_remove_handler(
     tizen_core_event_h h, tizen_core_event_handler_h event_handler);
 
-/**
- * @brief Emits the event to the tizen core event.
- * @since_tizen 9.0
- * @details The event is emitted to the tizen core event.
- *
- * @param[in] h The tizen core event handle
- * @param[in] object The tizen core event object handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_event_add_event_handler()
- */
 int tizen_core_event_emit(tizen_core_event_h h,
                           tizen_core_event_object_h object);
 
-/**
- * @brief Creates the tizen core event object handle.
- * @since_tizen 9.0
- *
- * @param[out] h The tizen core event object handle
- * @param[in] type The event type
- * @param[in] data The event data
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #TIZEN_CORE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #TIZEN_CORE_ERROR_INVALID_CONTEXT Invalid context
- * @see tizen_core_event_object_destroy()
- */
 int tizen_core_event_object_create(tizen_core_event_object_h *h, int type,
                                    void *data);
 
-/**
- * @brief Destroys the tizen core event object handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core event object handle
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_event_object_create()
- * @see tizen_core_event_object_set_on_destroy()
- */
 int tizen_core_event_object_destroy(tizen_core_event_object_h h);
 
-/**
- * @brief Sets the destroy callback function to invoke when the event object is
- * destroyed.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core event object handle
- * @param[in] callback The callback function to be invoked when the event object
- * is destroyed
- * @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- * @see tizen_core_event_object_destroy()
- */
 int tizen_core_event_object_set_on_destroy(
     tizen_core_event_object_h h, tizen_core_event_object_on_destroy_cb callback,
     void *user_data);
 
-/**
- * @brief Gets the event type from the tizen core event object handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core event object handle
- * @param[out] type The event type
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- */
 int tizen_core_event_object_get_type(tizen_core_event_object_h h, int *type);
 
-/**
- * @brief Gets the event data from the tizen core event object handle.
- * @since_tizen 9.0
- *
- * @param[in] h The tizen core event object handle
- * @param[out] data The event data
- * @return @c 0 on success,
- *         otherwise a negative error value
- * @retval #TIZEN_CORE_ERROR_NONE Successful
- * @retval #TIZEN_CORE_ERROR_INVALID_PARAMETER Invalid parameter
- */
 int tizen_core_event_object_get_data(tizen_core_event_object_h h, void **data);
 
-/**
- * @brief Generates the event type.
- * @since_tizen 9.0
- *
- * @return @c the event type on success,
- *         otherwise a negative error value.
- */
 int tizen_core_event_gen_type(void);
 
 #ifdef __cplusplus