From: Mu-Woong Lee <muwoong.lee@samsung.com>
Date: Fri, 16 Dec 2016 07:08:42 +0000 (+0900)
Subject: Fix typos & errors in doxygen tags
X-Git-Tag: submit/tizen_3.0/20161219.115913~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8dde1aa766a4422d7de57dad8da3f211eed4fcc0;p=platform%2Fcore%2Fapi%2Fsensor.git

Fix typos & errors in doxygen tags

Change-Id: I912704ac5b2766a5067ea8817836198ffcff1a24
Signed-off-by: Mu-Woong Lee <muwoong.lee@samsung.com>
---

diff --git a/include/sensor.h b/include/sensor.h
index 26ddd46..87c41e7 100644
--- a/include/sensor.h
+++ b/include/sensor.h
@@ -161,9 +161,9 @@ typedef enum
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]   type        A sensor type to check
- * @param[out]  supported   If supported, @c true; Otherwise @c false
+ * @param[out]  supported   If supported, @c true; otherwise @c false
  *
- * @return  #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return  #SENSOR_ERROR_NONE on success; otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
  * @retval  #SENSOR_ERROR_INVALID_PARAMETER    Invalid parameter
  */
@@ -178,7 +178,7 @@ int sensor_is_supported(sensor_type_e type, bool *supported);
  *
  * @param[in]   sensor  A sensor handle to check
  * @param[out]  wakeup  If the sensor is a wake-up sensor, @c true;
- *                      Otherwise @c false
+ *                      otherwise @c false
  *
  * @return  #SENSOR_ERROR_NONE on success, otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
@@ -191,10 +191,9 @@ int sensor_is_wake_up(sensor_h sensor, bool *wakeup);
 
 /**
  * @brief   Gets the handle for the default sensor of a given type.
- * @details This function returns the handle for the sensor of a given type,
- *          if the device has one sensor of the given type.
+ * @details This function returns the handle for the sensor of a given type.
  *          In case that the device has more than one sensors of the type,
- *          this returns only the default sensor, which is designated by the device.@n
+ *          this returns only the default sensor, which is designated by the device.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks Some sensor types are privileged. An application should have the privilege
@@ -206,7 +205,7 @@ int sensor_is_wake_up(sensor_h sensor, bool *wakeup);
  * @param[in]  type     A sensor type to get the handle of its default sensor
  * @param[out] sensor   The sensor handle of the default sensor
  *
- * @return  #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return  #SENSOR_ERROR_NONE on success; otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
  * @retval  #SENSOR_ERROR_INVALID_PARAMETER    Invalid parameter
  * @retval  #SENSOR_ERROR_NOT_SUPPORTED        The sensor type is not supported in the current device
@@ -230,15 +229,15 @@ int sensor_get_default_sensor(sensor_type_e type, sensor_h *sensor);
  *          #SENSOR_HRM, #SENSOR_HRM_LED_GREEN, #SENSOR_HRM_LED_IR, #SENSOR_HRM_LED_RED,
  *          #SENSOR_HUMAN_PEDOMETER, #SENSOR_HUMAN_SLEEP_MONITOR, #SENSOR_HUMAN_SLEEP_DETECTOR,
  *          and #SENSOR_HUMAN_STRESS_MONITOR.@n
- *          Instead of specifying a sensor type, by using #SENSOR_ALL,
- *          applications can get the list of handles for all available sensors.@n
- *          The @c list must be released using @c free(), if not being used anymore.@n
+ *          Instead of specifying a sensor type,
+ *          it is able to get the handles for all available sensors by using #SENSOR_ALL.@n
+ *          The @c list must be released using @c free(), if not being used anymore.
  *
  * @param[in]  type         A sensor type to get the list of sensor handles
  * @param[out] list         An array of the sensor handles
  * @param[out] sensor_count The number of handles contained in @c list
  *
- * @return  #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return  #SENSOR_ERROR_NONE on success; otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
  * @retval  #SENSOR_ERROR_INVALID_PARAMETER    Invalid parameter
  * @retval  #SENSOR_ERROR_NOT_SUPPORTED        The sensor type is not supported in the current device
@@ -357,11 +356,11 @@ int sensor_get_resolution(sensor_h sensor, float *resolution);
 
 
 /**
- * @brief   Gets the possible shorted update interval of a sensor.
+ * @brief   Gets the possible shortest update interval of a sensor.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]   sensor          A sensor handle
- * @param[out]  min_interval    The shorted interval in milliseconds
+ * @param[out]  min_interval    The shortest interval in milliseconds
  *
  * @return  #SENSOR_ERROR_NONE on success, otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
@@ -405,7 +404,7 @@ int sensor_get_fifo_count(sensor_h sensor, int *fifo_count);
  *
  * @param[in]   sensor          A sensor handle
  * @param[out]  max_batch_count If the sensor does not support batching, 0;
- *                              Otherwise a positive integer.
+ *                              otherwise a positive integer.
  *
  * @return  #SENSOR_ERROR_NONE on success, otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
@@ -508,7 +507,7 @@ typedef enum
 
 
 /**
- * @brief   Enumeration for reference orientations of sensor data
+ * @brief   Enumeration for reference orientations of sensor data.
  * @details The sensor's physical orientation may differ from what applications are aware of,
  *          in cases that the device has a rotated screen, physically or logically.
  *          For example, a watch device may have right hand mode, which logically rotates
@@ -530,7 +529,7 @@ typedef enum
 
 
 /**
- * @brief   Enumeration for pause policies of sensor listeners
+ * @brief   Enumeration for pause policies of sensor listeners.
  * @details To be power-efficient, you can set the policy of how to pause and resume
  *          a sensor listener regarding the system status.
  *          By default, #SENSOR_PAUSE_ALL is used to obtain the maximum power efficiency.
@@ -710,7 +709,7 @@ int sensor_listener_unset_event_cb(sensor_listener_h listener);
  * @retval  #SENSOR_ERROR_INVALID_PARAMETER    Invalid parameter
  * @retval  #SENSOR_ERROR_OPERATION_FAILED     Operation failed
  *
- * @pre     The @c listener needs to be started to get the change callbacks.
+ * @pre     The @c listener needs to be started to get the changed callbacks.
  * @see     sensor_listener_unset_accuracy_cb()
  */
 int sensor_listener_set_accuracy_cb(sensor_listener_h listener, sensor_accuracy_changed_cb callback, void *data);
@@ -763,13 +762,13 @@ int sensor_listener_read_data(sensor_listener_h listener, sensor_event_s *event)
  * @details The specified interval is only a suggested interval between sensor measurements.
  *          You will get at least one sensor measurement within the interval you specify,
  *          but the actual interval between sensor measurements can be affected by other applications and the system.
- *          To reduce the system overhead, it is recommended to set the longest interval that you can,
+ *          It is recommended to set the longest interval that satisfies your purpose,
  *          because the system usually chooses the shortest interval among all intervals specified.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks Normally, a sensor's default update interval is 100 ms,
  *          and you can use the default interval by setting the interval to 0.
- *          However, please note that, the default interval varies with the sensor and the device.@n
+ *          However, please note that the default interval varies with the sensor and the device.@n
  *          In addition, a sensor has the lower and the upper bound of its update interval,
  *          usually 10 and 1000 ms respectively.
  *          These lower and upper bounds also can vary with the sensor and the device,
@@ -799,7 +798,7 @@ int sensor_listener_set_interval(sensor_listener_h listener, unsigned int interv
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks Even if you set a batch latency, the sensor may not work as you intended,
- *          as one sensor can be used by more than one listeners.
+ *          as one sensor can be used by more than one listener.
  *          In addition, some batch sensors may already have fixed batching latency
  *          or batching queue size, which cannot be altered by applications.
  *
@@ -859,14 +858,14 @@ int sensor_listener_set_option(sensor_listener_h listener, sensor_option_e optio
 
 /**
  * @brief   Option handle to contain recording policies and parameters.
- * @details one or more sensor options can be created by using sensor_recorder_create_option().
+ * @details One or more sensor options can be created by using sensor_recorder_create_option().
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  */
 typedef void *sensor_recorder_option_h;
 
 /**
  * @brief   Query handle to contain filtering and aggregation parameters for recorded data.
- * @details one or more sensor options can be created by using sensor_recorder_create_query().
+ * @details One or more sensor options can be created by using sensor_recorder_create_query().
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  */
 typedef void *sensor_recorder_query_h;
@@ -894,14 +893,14 @@ typedef enum
 /**
  * @brief   Enumeration for intervals between data records.
  * @details Some sensor types including #SENSOR_HRM may not fit to continuous monitoring and recording.
- *          To reduce the battery use for recoridng such sensors, recording interval between each
- *          sensor data is chosen. For example, an application set the interval of 1 hour,
+ *          To reduce the battery use for recording such sensors, recording interval between each
+ *          sensor data is chosen. For example, an application sets the interval of 1 hour,
  *          the platform tries to retrieve the sensor data only once per hour, thus it will be more
  *          battery efficient than to listen the sensor data continuously.@n
- *          If the application does not set the interval explicitely, the default value is chosen.
- *          The default values are differ from sensor to sensor.
+ *          If the application does not set the interval explicitly, the default value is chosen.
+ *          The default values differ from sensor to sensor.
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
- * @remarks If more than one applications set different intervals, the shortest value is chosen.
+ * @remarks If more than one application set different intervals, the shortest value is chosen.
  */
 typedef enum
 {
@@ -914,7 +913,7 @@ typedef enum
 } sensor_recorder_interval_e;
 
 /**
- * @brief   Enumeration for filtering and aggregation parameters for queyring sensor records.
+ * @brief   Enumeration for filtering and aggregation parameters for querying sensor records.
  * @details None, one, or more query parameters can be set to #sensor_recorder_query_h,
  *          to specify the data to be retrieved via sensor_recorder_read().
  *          If a necessary parameter is not set, the default value is chosen.
@@ -958,13 +957,13 @@ typedef enum
 } sensor_recorder_data_e;
 
 /**
- * @brief   Checks whether it is suppored to record a given sensor type.
+ * @brief   Checks whether it is supported to record a given sensor type.
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  *
  * @param[in]   type        A sensor type to check
- * @param[out]  supported   If supported, @c true; Otherwise @c false
+ * @param[out]  supported   If supported, @c true; otherwise @c false
  *
- * @return  #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return  #SENSOR_ERROR_NONE on success; otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
  * @retval  #SENSOR_ERROR_INVALID_PARAMETER    Invalid parameter
  * @retval  #SENSOR_ERROR_OPERATION_FAILED     Operation failed
@@ -1086,7 +1085,7 @@ int sensor_recorder_create_query(sensor_recorder_query_h *query);
 int sensor_recorder_destroy_query(sensor_recorder_query_h query);
 
 /**
- * @brief   Sets an integer-type query parameter
+ * @brief   Sets an integer-type query parameter.
  * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
  *
  * @param[in]  query       Query handle
@@ -1116,7 +1115,7 @@ int sensor_recorder_query_set_int(sensor_recorder_query_h query, sensor_recorder
 int sensor_recorder_query_set_time(sensor_recorder_query_h query, sensor_recorder_query_e param, time_t t);
 
 /**
- * @brief   Called when the query results are retieved.
+ * @brief   Called when the query results are retrieved.
  * @details One of the following errors can be delivered.\n
  *          #SENSOR_ERROR_NONE, Successful\n
  *          #SENSOR_ERROR_OPERATION_FAILED, Operation failed\n
@@ -1129,7 +1128,7 @@ int sensor_recorder_query_set_time(sensor_recorder_query_h query, sensor_recorde
  * @param[in]  error       Error
  * @param[in]  user_data   The user data passed from sensor_recorder_read() or sensor_recorder_read_sync()
  *
- * @return  If @c true, it continues to iterate to the next record; If @c false, the iteration stops
+ * @return  If @c true, it continues to iterate to the next record; if @c false, the iteration stops
  */
 typedef bool (*sensor_recorder_data_cb)(sensor_type_e type, sensor_recorder_data_h data, int remains, sensor_error_e error, void *user_data);
 
@@ -1268,11 +1267,11 @@ typedef enum
  * @details [0 0 g] = R * gravity (g = magnitude of gravity) \n
  *          [0 m 0] = I * R * geomagnetic (m = magnitude of the geomagnetic field) \n
  *          R is the identity matrix when the device is aligned with the world's coordinate system, that is, when the device's X axis points towards the East, the Y axis points to the North Pole and the device is facing the sky. \n
- *          I is a rotation matrix transforming the geomagnetic vector into the same coordinate space as gravity (the world's coordinate space). I is a simple rotation around the X axis. \n
+ *          I is a rotation matrix transforming the geomagnetic vector into the same coordinate space as gravity (the world's coordinate space). I is a simple rotation around the X axis.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks Parameters Gx, Gy, and Gz can be obtained from the values returned by #SENSOR_GRAVITY. \n
- *          Parameters Mx, My, and Mz can be obtained from the values returned by #SENSOR_MAGNETIC.
+ *          Parameters Mx, My, and Mz can be obtained from the values returned by #SENSOR_MAGNETIC. \n
  *          Output parameter R and I are always returned as a 3x3 matrix array of 9 floats like this form:
  *          <pre>
  *          { R[0], R[1], R[2],
@@ -1292,7 +1291,7 @@ typedef enum
  * @param[out] I    The array of 9 floats that represent the inclination matrix "I" \n
  *                  It can be null.
  *
- * @return  #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return  #SENSOR_ERROR_NONE on success; otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
  * @retval  #SENSOR_ERROR_INVALID_PARAMETER    Invalid parameter
  */
@@ -1324,15 +1323,15 @@ int sensor_util_get_rotation_matrix_from_vector(float Vx, float Vy, float Vz, fl
  * @details This is typically used when an application needs to compute the three orientation angles of the device in a different coordinate system.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks inR and outR can be the same array, but this is not recommended for performance reasons.
- *          This returns an error when X and Y define the same axis.
+ * @remarks inR and outR can be the same array, but this is not recommended for performance reasons.@n
+ *          @c x and @c y should be perpendicular to each other. Otherwise, this function returns an error.
  *
  * @param[in]  inR  The rotation matrix (3x3) to be transformed
  * @param[in]  x    The world axis and direction on which the X axis of the device is mapped
  * @param[in]  y    The world axis and direction on which the Y axis of the device is mapped
  * @param[out] outR The transformed rotation matrix (3x3)
  *
- * @return  #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return  #SENSOR_ERROR_NONE on success; otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
  * @retval  #SENSOR_ERROR_INVALID_PARAMETER    Invalid parameter
  *
@@ -1346,7 +1345,7 @@ int sensor_util_remap_coordinate_system(float inR[], sensor_util_axis_e x, senso
  * @param[in]  I            The inclination matrix from sensor_util_get_rotation_matrix()
  * @param[out] inclination  The geomagnetic inclination angle in radians
  *
- * @return  #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return  #SENSOR_ERROR_NONE on success; otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
  * @retval  #SENSOR_ERROR_INVALID_PARAMETER    Invalid parameter
  *
@@ -1369,7 +1368,7 @@ int sensor_util_get_inclination(float I[], float* inclination);
  * @param[in]  R         A 9 element rotation matrix in the array
  * @param[out] values    An array of 3 floats to hold the result
  *
- * @return  #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return  #SENSOR_ERROR_NONE on success; otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
  * @retval  #SENSOR_ERROR_INVALID_PARAMETER    Invalid parameter
  *
@@ -1383,7 +1382,7 @@ int sensor_util_get_orientation(float R[], float values[]);
  *
  * @details Given a current rotation matrix (R) and a previous rotation matrix (prevR), it computes
  *          the rotation around the x,y, and z axes which transforms prevR to R.
- *          It outputs a 3 element vector containing the x,y, and z angle change at indexes 0, 1, and 2 respectively. \n
+ *          It outputs a 3 element vector containing the x,y, and z angle change at indexes 0, 1, and 2 respectively.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks Each input matrix is a 3x3 matrix like this form:
@@ -1397,7 +1396,7 @@ int sensor_util_get_orientation(float R[], float values[]);
  * @param[in] prevR         The previous rotation matrix
  * @param[out] angleChange  An array of floats in which the angle change is stored
  *
- * @return  #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return  #SENSOR_ERROR_NONE on success; otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
  * @retval  #SENSOR_ERROR_INVALID_PARAMETER    Invalid parameter
  */
@@ -1412,7 +1411,7 @@ int sensor_util_get_angle_change(float R[], float prevR[], float angleChange[]);
  * @param[in]  altitude     The altitude in geodetic coordinates
  * @param[out] declination  The declination of the horizontal component of the magnetic field in degrees
  *
- * @return  #SENSOR_ERROR_NONE on success; Otherwise a negative error value
+ * @return  #SENSOR_ERROR_NONE on success; otherwise a negative error value
  * @retval  #SENSOR_ERROR_NONE                 Successful
  * @retval  #SENSOR_ERROR_INVALID_PARAMETER    Invalid parameter
  */