projects / platform / core / api / sensor.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 7034de3)
sensor: update doxygen 66/112266/1 accepted/tizen_3.0_ivi tizen_3.0_tv accepted/tizen/3.0/common/20170201.164038 accepted/tizen/3.0/ivi/20170201.034935 accepted/tizen/3.0/mobile/20170201.034838 accepted/tizen/3.0/tv/20170201.034854 accepted/tizen/3.0/wearable/20170201.034915 submit/tizen_3.0/20170131.094136
authorkibak.yoon <kibak.yoon@samsung.com>
Tue, 31 Jan 2017 01:38:51 +0000 (10:38 +0900)
committerkibak.yoon <kibak.yoon@samsung.com>
Tue, 31 Jan 2017 01:38:51 +0000 (10:38 +0900)
- put a period at the end of a sentence
- align the lines

Change-Id: Idc5b87132856c21bdb1b018a762a2b214c7f1ab8
Signed-off-by: kibak.yoon <kibak.yoon@samsung.com>
doc/sensor_doc.h patch | blob | history

diff --git a/doc/sensor_doc.h b/doc/sensor_doc.h
index 94ffaadc3433b3fa455fbfaade38324c7f9fd5a0..f5d6560847206821957f055b9fbd6434756de19b 100644 (file)
--- 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 <sensor.h>
- *
- * @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 <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
- *
+ * @brief    The @ref CAPI_SYSTEM_SENSOR_MODULE API provides sensor types and sensor information.
+ *
+ * @section  CAPI_SYSTEM_SENSOR_MODULE_HEADER Required Header
+ *           \#include <sensor.h>
+ *
+ * @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 <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  */
 
  /**
- * @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 <sensor.h>
- *
- * @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 <sensor.h>
  *
+ * @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 <sensor.h>
+ * @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 <sensor.h>
  *
+ * @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 <sensor.h>
+ * @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 <sensor.h>
  *
+ * @section  CAPI_SYSTEM_SENSOR_UTILITY_MODULE_OVERVIEW Overview
+ *           This Sensor API provides utility functions.
  */
 
 
Domain: System / System Framework;