revise API referencesubmit/tizen_3.0/20170110.045429accepted/tizen/3.0/wearable/20170111.085450accepted/tizen/3.0/tv/20170111.085427accepted/tizen/3.0/mobile/20170111.085413accepted/tizen/3.0/ivi/20170111.085503accepted/tizen/3.0/common/20170111.161603

Change-Id: Iebd640dc8b8ef0768d5c19b2eae1b90ea479b5e6

1 files changed, 45 insertions, 58 deletions

diff --git a/include/iotcon-observers.h b/include/iotcon-observers.h
index 9961936..9dc9062 100644
--- a/include/iotcon-observers.h
+++ b/include/iotcon-observers.h
@@ -13,27 +13,28 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+
 #ifndef __IOTCON_SERVER_OBSERVERS_H__
 #define __IOTCON_SERVER_OBSERVERS_H__
 
+
 #include <iotcon-types.h>
 
+
 /**
  * @file iotcon-observers.h
  */
 
+
 /**
  * @ingroup CAPI_IOT_CONNECTIVITY_SERVER_MODULE
  * @defgroup CAPI_IOT_CONNECTIVITY_SERVER_OBSERVERS_MODULE Observers
- *
  * @brief IoTCon Observers provides API to manage client observing a resource.
- *
  * @section CAPI_IOT_CONNECTIVITY_SERVER_OBSERVERS_MODULE_HEADER Required Header
- *  \#include <iotcon.h>
- *
+ *          \#include <iotcon.h>
  * @section CAPI_IOT_CONNECTIVITY_SERVER_OBSERVERS_MODULE_OVERVIEW Overview
- * The iotcon overview API provides methods for managing observe id.
- *
+ *          The IoTcon overview API provides methods for managing observe ID.
  * Example :
  * @code
 #include <iotcon.h>
@@ -112,102 +113,88 @@ static void _request_handler(iotcon_resource_h resource, iotcon_request_h reques
 	...
 }
  * @endcode
- *
  * @section CAPI_IOT_CONNECTIVITY_SERVER_OBSERVERS_MODULE_FEATURE Related Features
- * This API is related with the following features:\n
- *  - http://tizen.org/feature/iot.ocf\n
- *
- * It is recommended to design feature related codes in your application for reliability.\n
- *
- * 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.\n
- *
- * 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.\n
- *
- * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
- *
+ *          This API is related with the following features: \n
+ *          - http://tizen.org/feature/iot.ocf \n
+ *          It is recommended to design feature related codes in your application for reliability.\n
+ *          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.\n
+ *          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.\n
+ *          More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  * @{
  */
 
+
 /**
  * @brief Creates a new observers handle.
- *
  * @since_tizen 3.0
- *
- * @remarks You must destroy @a observers by calling iotcon_observers_destroy()
- * if @a observers is no longer needed.
- *
+ * @remarks You must destroy @a observers by calling iotcon_observers_destroy() if @a observers is no longer needed.
  * @param[out] observers A newly allocated list of observers handle
- *
- * @return 0 on success, otherwise a negative error value.
- * @retval #IOTCON_ERROR_NONE  Successful
- * @retval #IOTCON_ERROR_NOT_SUPPORTED  Not supported
- * @retval #IOTCON_ERROR_INVALID_PARAMETER  Invalid parameter
- * @retval #IOTCON_ERROR_OUT_OF_MEMORY  Out of memory
- *
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #IOTCON_ERROR_NONE Successful
+ * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported
+ * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #IOTCON_ERROR_OUT_OF_MEMORY Out of memory
  * @see iotcon_observers_destroy()
  * @see iotcon_observers_add()
  * @see iotcon_observers_remove()
  */
 int iotcon_observers_create(iotcon_observers_h *observers);
 
+
 /**
  * @brief Destroys a observers handle.
- *
  * @since_tizen 3.0
- *
  * @param[in] observers The handle of the observers
- *
- * @return 0 on success, otherwise a negative error value.
- * @retval #IOTCON_ERROR_NONE  Successful
- * @retval #IOTCON_ERROR_NOT_SUPPORTED  Not supported
- * @retval #IOTCON_ERROR_INVALID_PARAMETER  Invalid parameter
- *
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #IOTCON_ERROR_NONE Successful
+ * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported
+ * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter
  * @see iotcon_observers_create()
  * @see iotcon_observers_add()
  * @see iotcon_observers_remove()
  */
 int iotcon_observers_destroy(iotcon_observers_h observers);
 
+
 /**
- * @brief Adds a observer id into the observers handle.
- *
+ * @brief Adds an observers ID into the observers handle.
  * @since_tizen 3.0
- *
  * @param[in] observers The handle of the observers
- * @param[in] obs_id The id to be appended to observers
- *
- * @return 0 on success, otherwise a negative error value.
- * @retval #IOTCON_ERROR_NONE  Successful
- * @retval #IOTCON_ERROR_NOT_SUPPORTED  Not supported
- * @retval #IOTCON_ERROR_INVALID_PARAMETER  Invalid parameter
- *
+ * @param[in] obs_id The ID to be appended to observers
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #IOTCON_ERROR_NONE Successful
+ * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported
+ * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter
  * @see iotcon_observers_create()
  * @see iotcon_observers_destroy()
  * @see iotcon_observers_remove()
  */
 int iotcon_observers_add(iotcon_observers_h observers, int obs_id);
 
+
 /**
- * @brief Removes id from the observers.
- *
+ * @brief Removes ID from the observers.
  * @since_tizen 3.0
- *
  * @param[in] observers observers The handle of the observers
- * @param[in] obs_id The id to be removed from observers
- *
- * @return 0 on success, otherwise a negative error value.
- * @retval #IOTCON_ERROR_NONE  Successful
- * @retval #IOTCON_ERROR_NOT_SUPPORTED  Not supported
- * @retval #IOTCON_ERROR_INVALID_PARAMETER  Invalid parameter
- *
+ * @param[in] obs_id The ID to be removed from observers
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #IOTCON_ERROR_NONE Successful
+ * @retval #IOTCON_ERROR_NOT_SUPPORTED Not supported
+ * @retval #IOTCON_ERROR_INVALID_PARAMETER Invalid parameter
  * @see iotcon_observers_create()
  * @see iotcon_observers_destroy()
  * @see iotcon_observers_add()
  */
 int iotcon_observers_remove(iotcon_observers_h observers, int obs_id);
 
+
 /**
  * @}
  */
 
+
 #endif /* __IOTCON_SERVER_OBSERVERS_H__ */