Fix descriptions of sensor-internal.h according to the API checker script

Warning messages from the API checker about the description of invalid parameter(return value)
was ignored since the description is already mentioning the return value about invalid parameter.

Change-Id: Ib272acbed14a98c94eaec964883c4d92d6c987e9
Signed-off-by: SangYoun Kwak <sy.kwak@samsung.com>

diff --git a/include/sensor-internal.h b/include/sensor-internal.h
index 04ef69a..adea3d3 100644 (file)
--- a/include/sensor-internal.h
+++ b/include/sensor-internal.h
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef __SENSOR_INTERNAL_H__
-#define __SENSOR_INTERNAL_H__
+#ifndef __TIZEN_SYSTEM_SENSOR_INTERNAL_H__
+#define __TIZEN_SYSTEM_SENSOR_INTERNAL_H__
 
 #include <sensor.h>
 #include <hal-sensor-types.h>
@@ -25,15 +25,20 @@ extern "C"
 {
 #endif
 
+/**
+ * @brief Enumeration for sensor types.
+ * @since_tizen 6.5
+ */
 typedef enum {
-       SENSOR_LIDAR = 1000,
+       SENSOR_LIDAR = 1000, /**< Sensor type LIDAR */
 } sensor_type_internel_e;
 
 /**
- * @brief Set the attribute to a connected sensor
+ * @brief Sets the attribute to a connected sensor.
+ * @since_tizen 6.5
  *
  * @param[in] type a sensor type of represensting a connected sensor
- * @param[in] attribute an attribute to change
+ * @param[in] attr an attribute to change
  * @param[in] value an attribute value
  * @return 0 on success, otherwise a negative error value
  * @retval 0 Successful
@@ -43,10 +48,11 @@ typedef enum {
 int sensor_util_set_attribute_int(sensor_type_e type, sensor_attribute_e attr, int value);
 
 /**
- * @brief Get the attribute to a connected sensor
+ * @brief Gets the attribute to a connected sensor.
+ * @since_tizen 6.5
  *
  * @param[in] type a sensor type of represensting a connected sensor
- * @param[in] attribute an attribute to get value
+ * @param[in] attr an attribute to get value
  * @param[out] value an attribute value
  * @return 0 on success, otherwise a negative error value
  * @retval 0 Successful
@@ -59,4 +65,4 @@ int sensor_util_get_attribute_int(sensor_type_e type, sensor_attribute_e attr, i
 }
 #endif
 
-#endif /* __SENSOR_INTERNAL_H__ */
+#endif /* __TIZEN_SYSTEM_SENSOR_INTERNAL_H__ */