Modify api documentation

Change-Id: I763fd3163014bd3872f481e2372082f61c13fd57
Signed-off-by: SukhyungKang <shine.kang@samsung.com>

diff --git a/include/widget_service.h b/include/widget_service.h
index 1105be7fed6166d89701b67883ecc417825e5c5a..8577ce0b61bae866e3ae6e85493be14933fc376d 100644 (file)
--- a/include/widget_service.h
+++ b/include/widget_service.h
@@ -516,6 +516,7 @@ int widget_service_get_nodisplay(const char *widget_id);
  * @since_tizen 2.3.1
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.viewer
+ * @remarks @a w and @a h should be released using free().
  * @param[in] widget_id appid of widget application
  * @param[in,out] cnt Count of array w and h
  * @param[out] w Width array
@@ -526,6 +527,25 @@ int widget_service_get_nodisplay(const char *widget_id);
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #WIDGET_ERROR_IO_ERROR Failed to access DB
+ * @par Example
+ * @code
+#include <widget_service.h>
+
+int main()
+{
+  int ret;
+  int *w;
+  int *h;
+  int cnt = 0;
+
+  ret = widget_service_get_supported_sizes("widget_id", &cnt, &w, &h);
+  ...
+  free(w);
+  free(h);
+
+  return 0;
+}
+ * @endcode
  * @see widget_service_get_supported_size_types()
  */
 int widget_service_get_supported_sizes(const char *widget_id, int *cnt, int **w, int **h);
@@ -536,6 +556,7 @@ int widget_service_get_supported_sizes(const char *widget_id, int *cnt, int **w,
  * @since_tizen 2.3.1
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.viewer
+ * @remarks The @a types should be released using free().
  * @param[in] widgetid appid of widget application
  * @param[in] cnt Size of types array
  * @param[out] types Array of types
@@ -545,6 +566,23 @@ int widget_service_get_supported_sizes(const char *widget_id, int *cnt, int **w,
  * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied
  * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument
  * @retval #WIDGET_ERROR_IO_ERROR Failed to access DB
+ * @par Example
+ * @code
+#include <widget_service.h>
+
+int main()
+{
+  int ret;
+  int cnt = 0;
+  int *types;
+
+  ret = widget_service_get_supported_size_types("widget_id", &cnt, &types);
+  ...
+  free(tyeps);
+
+  return 0;
+}
+ * @endcode
  * @see widget_service_get_supported_sizes()
  */
 int widget_service_get_supported_size_types(const char *widgetid, int *cnt, int **types);
@@ -630,6 +668,7 @@ int widget_service_set_lifecycle_event_cb(const char *widget_id, widget_lifecycl
 /**
  * @brief Unsets event handler callback function for life cycle events of widgets.
  * @since_tizen 2.3.1
+ * @remarks Releasing the @a user_data depends on @a data that set by widget_service_set_lifecycle_event_cb() function.
  * @param[in] widget_id appid of widget application
  * @param[out] user_data User callback data
  * @return @c 0 on success,