From: kibak.yoon Date: Tue, 31 Jan 2017 01:38:51 +0000 (+0900) Subject: sensor: update doxygen X-Git-Tag: submit/tizen_3.0/20170131.094136^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=4c292962002fdcf0530448a7b459e5da7e40073f;p=platform%2Fcore%2Fapi%2Fsensor.git sensor: update doxygen - put a period at the end of a sentence - align the lines Change-Id: Idc5b87132856c21bdb1b018a762a2b214c7f1ab8 Signed-off-by: kibak.yoon --- diff --git a/doc/sensor_doc.h b/doc/sensor_doc.h index 94ffaad..f5d6560 100644 --- a/doc/sensor_doc.h +++ b/doc/sensor_doc.h @@ -18,97 +18,87 @@ #ifndef __TIZEN_SYSTEM_SENSOR_DOC_H__ #define __TIZEN_SYSTEM_SENSOR_DOC_H__ - /** - * @ingroup CAPI_SYSTEM_FRAMEWORK +/** + * @ingroup CAPI_SYSTEM_FRAMEWORK * @defgroup CAPI_SYSTEM_SENSOR_MODULE Sensor - * @brief The @ref CAPI_SYSTEM_SENSOR_MODULE API provides sensor types and sensor information - * - * @section CAPI_SYSTEM_SENSOR_MODULE_HEADER Required Header - * \#include - * - * @section CAPI_SYSTEM_SENSOR_MODULE_OVERVIEW Overview - * This Sensor API provides sensor types and sensor error types to make use of sensors in the - * device. A variety of hardware/virtual sensors are typically available on - * mobile devices. - * This Sensor API also provides functions for sensor information, such as name, vendor. - * - * @section CAPI_SYSTEM_SENSOR_MODULE_FEATURE Related Features - * This API is related with the following features:\n - * - http://tizen.org/feature/sensor.accelerometer\n - * - http://tizen.org/feature/sensor.barometer\n - * - http://tizen.org/feature/sensor.gyroscope\n - * - http://tizen.org/feature/sensor.magnetometer\n - * - http://tizen.org/feature/sensor.photometer\n - * - http://tizen.org/feature/sensor.proximity\n - * - http://tizen.org/feature/sensor.tiltmeter\n - * - http://tizen.org/feature/sensor.ultraviolet\n - * - http://tizen.org/feature/sensor.temperature\n - * - http://tizen.org/feature/sensor.humidity\n - * - http://tizen.org/feature/sensor.linear_acceleration\n - * - http://tizen.org/feature/sensor.rotation_vector\n - * - http://tizen.org/feature/sensor.gravity\n - * - http://tizen.org/feature/sensor.heart_rate_monitor\n - * - http://tizen.org/feature/sensor.heart_rate_monitor.led_green\n - * - http://tizen.org/feature/sensor.heart_rate_monitor.led_ir\n - * - http://tizen.org/feature/sensor.heart_rate_monitor.led_red\n - * - http://tizen.org/feature/sensor.gyroscope.uncalibrated\n - * - http://tizen.org/feature/sensor.magnetometer.uncalibrated\n - * - http://tizen.org/feature/sensor.gyroscope_rotation_vector\n - * - http://tizen.org/feature/sensor.geomagnetic_rotation_vector\n - * - http://tizen.org/feature/sensor.pedometer\n - * - http://tizen.org/feature/sensor.sleep_monitor\n - * - http://tizen.org/feature/sensor.stress_monitor\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 Feature Element. - * + * @brief The @ref CAPI_SYSTEM_SENSOR_MODULE API provides sensor types and sensor information. + * + * @section CAPI_SYSTEM_SENSOR_MODULE_HEADER Required Header + * \#include + * + * @section CAPI_SYSTEM_SENSOR_MODULE_OVERVIEW Overview + * This Sensor API provides sensor types and sensor error types to make use of sensors in the device. + * A variety of hardware/virtual sensors are typically available on mobile devices. + * This Sensor API also provides functions for sensor information, such as name, vendor. + * + * @section CAPI_SYSTEM_SENSOR_MODULE_FEATURE Related Features + * This API is related with the following features:\n + * - http://tizen.org/feature/sensor.accelerometer\n + * - http://tizen.org/feature/sensor.barometer\n + * - http://tizen.org/feature/sensor.gyroscope\n + * - http://tizen.org/feature/sensor.magnetometer\n + * - http://tizen.org/feature/sensor.photometer\n + * - http://tizen.org/feature/sensor.proximity\n + * - http://tizen.org/feature/sensor.tiltmeter\n + * - http://tizen.org/feature/sensor.ultraviolet\n + * - http://tizen.org/feature/sensor.temperature\n + * - http://tizen.org/feature/sensor.humidity\n + * - http://tizen.org/feature/sensor.linear_acceleration\n + * - http://tizen.org/feature/sensor.rotation_vector\n + * - http://tizen.org/feature/sensor.gravity\n + * - http://tizen.org/feature/sensor.heart_rate_monitor\n + * - http://tizen.org/feature/sensor.heart_rate_monitor.led_green\n + * - http://tizen.org/feature/sensor.heart_rate_monitor.led_ir\n + * - http://tizen.org/feature/sensor.heart_rate_monitor.led_red\n + * - http://tizen.org/feature/sensor.gyroscope.uncalibrated\n + * - http://tizen.org/feature/sensor.magnetometer.uncalibrated\n + * - http://tizen.org/feature/sensor.gyroscope_rotation_vector\n + * - http://tizen.org/feature/sensor.geomagnetic_rotation_vector\n + * - http://tizen.org/feature/sensor.pedometer\n + * - http://tizen.org/feature/sensor.sleep_monitor\n + * - http://tizen.org/feature/sensor.stress_monitor\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 Feature Element. */ /** - * @ingroup CAPI_SYSTEM_SENSOR_MODULE + * @ingroup CAPI_SYSTEM_SENSOR_MODULE * @defgroup CAPI_SYSTEM_SENSOR_LISTENER_MODULE Sensor Listener - * @brief The @ref CAPI_SYSTEM_SENSOR_LISTENER_MODULE API provides functions to start/stop sensors and receive sensor events. + * @brief The @ref CAPI_SYSTEM_SENSOR_LISTENER_MODULE API provides functions to start/stop sensors and receive sensor events. * - * @section CAPI_SYSTEM_SENSOR_LISTENER_MODULE_HEADER Required Header - * \#include - * - * @section CAPI_SYSTEM_SENSOR_MODULE_OVERVIEW Overview - * This Sensor API provides functions to make use of sensors in the - * device. A variety of hardware/virtual sensors are typically available on - * mobile devices. + * @section CAPI_SYSTEM_SENSOR_LISTENER_MODULE_HEADER Required Header + * \#include * + * @section CAPI_SYSTEM_SENSOR_MODULE_OVERVIEW Overview + * This Sensor API provides functions to make use of sensors in the device. + * A variety of hardware/virtual sensors are typically available on mobile devices. */ /** - * @ingroup CAPI_SYSTEM_SENSOR_MODULE + * @ingroup CAPI_SYSTEM_SENSOR_MODULE * @defgroup CAPI_SYSTEM_SENSOR_RECORDER_MODULE Sensor Recorder - * @brief The @ref CAPI_SYSTEM_SENSOR_RECORDER_MODULE API provides functions to start/stop recording sensor events and read the recorded data. - * - * @section CAPI_SYSTEM_SENSOR_RECORDER_MODULE_HEADER Required Header - * \#include + * @brief The @ref CAPI_SYSTEM_SENSOR_RECORDER_MODULE API provides functions to start/stop recording sensor events and read the recorded data. * - * @section CAPI_SYSTEM_SENSOR_MODULE_OVERVIEW Overview - * This Sensor API provides functions to record sensors events in the device. - * Several sensors are typically available on mobile devices. + * @section CAPI_SYSTEM_SENSOR_RECORDER_MODULE_HEADER Required Header + * \#include * + * @section CAPI_SYSTEM_SENSOR_MODULE_OVERVIEW Overview + * This Sensor API provides functions to record sensors events in the device. + * Several sensors are typically available on mobile devices. */ /** - * @ingroup CAPI_SYSTEM_SENSOR_MODULE + * @ingroup CAPI_SYSTEM_SENSOR_MODULE * @defgroup CAPI_SYSTEM_SENSOR_UTILITY_MODULE Sensor Utility - * @brief The @ref CAPI_SYSTEM_SENSOR_UTILITY_MODULE API provides utility functions. - * - * @section CAPI_SYSTEM_SENSOR_UTILITY_MODULE_HEADER Required Header - * \#include + * @brief The @ref CAPI_SYSTEM_SENSOR_UTILITY_MODULE API provides utility functions. * - * @section CAPI_SYSTEM_SENSOR_UTILITY_MODULE_OVERVIEW Overview - * This Sensor API provides utility functions. + * @section CAPI_SYSTEM_SENSOR_UTILITY_MODULE_HEADER Required Header + * \#include * + * @section CAPI_SYSTEM_SENSOR_UTILITY_MODULE_OVERVIEW Overview + * This Sensor API provides utility functions. */