Fix doxygen errors 15/240415/1
authorhyunho <hhstark.kang@samsung.com>
Thu, 6 Aug 2020 06:52:36 +0000 (15:52 +0900)
committerhyunho <hhstark.kang@samsung.com>
Thu, 6 Aug 2020 06:52:36 +0000 (15:52 +0900)
Change-Id: Ia5266a57976a1c473306058d6c59fe58bc5a802f
Signed-off-by: hyunho <hhstark.kang@samsung.com>
doc/appcore-watch_doc.h
include/watch_app.h

index 8e30c2f..d634342 100755 (executable)
@@ -39,7 +39,7 @@
  * It is recommended to design feature related codes in your application for reliability.
  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
- * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
+ * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
  *
  * @subsection CAPI_WATCH_APP_MODULE_STATE_CHANGE_EVENT Registering Callbacks for Application State Change Events
  * The state change events for Tizen watch application is similar to the Tizen UI applications. See the @ref CAPI_APPLICATION_MODULE.
index e8c483c..ee92473 100755 (executable)
@@ -32,7 +32,7 @@ extern "C" {
  */
 
 /**
- * @brief watch_time_h watch_time handle
+ * @brief #watch_time_h watch_time handle.
  * @since_tizen 2.3.1
  */
 typedef struct _watch_time_s *watch_time_h;
@@ -121,7 +121,7 @@ typedef void (*watch_app_time_tick_cb) (watch_time_h watch_time, void *user_data
 /**
  * @brief Called with the frequency set with watch_app_set_ambient_tick_type() if the device is in the ambient mode.
  * @since_tizen 2.3.1
- * @remarks You should not do a job that takes long time in this callback. You should update the UI as fast as possible in this callback. 
+ * @remarks You should not do a job that takes long time in this callback. You should update the UI as fast as possible in this callback.
  *          The platform might make the device to sleep in short time after the ambient tick expires.
  *          Since 2.3.2, you can control when this callback is called by watch_app_set_ambient_tick_type()
  * @param[in] watch_time The watch time handle. watch_time will not be available after returning this callback. It will be freed by the framework.
@@ -134,10 +134,10 @@ typedef void (*watch_app_ambient_tick_cb) (watch_time_h watch_time, void *user_d
 /**
  * @brief Called when the device enters or exits the ambient mode.
  * @since_tizen 2.3.1
- * @remarks For low powered wearable device, Tizen watch application supports a special mode that is named 'ambient'. 
- *          When the device enters ambient mode, Tizen watch application that is shown in the idle screen can show limited UI and receives only ambient tick event at each minute to reduce power consumption. 
- *          The limitation of UI that can be drawn in the ambient mode depends on the device. 
- *          Usually, you should draw black and white UI only, and you should use below 20% of the pixels of the screen. 
+ * @remarks For low powered wearable device, Tizen watch application supports a special mode that is named 'ambient'.
+ *          When the device enters ambient mode, Tizen watch application that is shown in the idle screen can show limited UI and receives only ambient tick event at each minute to reduce power consumption.
+ *          The limitation of UI that can be drawn in the ambient mode depends on the device.
+ *          Usually, you should draw black and white UI only, and you should use below 20% of the pixels of the screen.
  *          If you don't want to draw your own ambient mode UI, you can set the 'ambient-support' attribute of the application as 'false' in the tizen-manifest.xml. Then, the platform will show proper default ambient mode UI.
  * @param[in] ambient_mode If @c true the device enters the ambient mode,
  *                         otherwise @c false
@@ -221,7 +221,6 @@ int watch_app_remove_event_handler(app_event_handler_h event_handler);
  * @retval #APP_ERROR_INVALID_CONTEXT The application is illegally launched, not launched by the launch system.
  * @retval #APP_ERROR_ALREADY_RUNNING The main loop has already started
  * @retval #APP_ERROR_NOT_SUPPORTED Not supported
- * @see watch_app_main()
  * @see watch_app_create_cb()
  * @see watch_app_control_cb()
  * @see watch_app_pause_cb()
@@ -370,7 +369,8 @@ int watch_app_set_ambient_tick_type(watch_app_ambient_tick_type_e type);
 /**
  * @brief Gets the type of periodic ambient tick.
  * @since_tizen 2.3.2
- * @remarks If you do not set specific tick type with watch_app_set_ambient_tick_type(), this function will set @a type to #WATCH_APP_AMBIENT_TICK_EVERY_MINUTE. * @param[out] type The type of periodic ambient tick
+ * @remarks If you do not set specific tick type with watch_app_set_ambient_tick_type(), this function will set @a type to #WATCH_APP_AMBIENT_TICK_EVERY_MINUTE.
+ * @param[out] type The type of periodic ambient tick
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #APP_ERROR_NONE Successful