Fix descriptions of sensor-internal.h according to the API checker script 93/287393/1
authorSangYoun Kwak <sy.kwak@samsung.com>
Thu, 13 Oct 2022 05:08:24 +0000 (14:08 +0900)
committerTaeminYeom <taemin.yeom@samsung.com>
Fri, 27 Jan 2023 10:36:03 +0000 (19:36 +0900)
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>
include/sensor-internal.h

index 9c90969b809595355995a55cef6d91368e9c7199..177f233fd5ee1a430e6c00431689a855da2fbb44 100644 (file)
@@ -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>
@@ -32,7 +32,7 @@ extern "C"
  * @since_tizen 6.5
  */
 typedef enum {
-       SENSOR_LIDAR = 1000,
+       SENSOR_LIDAR = 1000, /**< Sensor type LIDAR */
 } sensor_type_internel_e;
 
 /**
@@ -73,7 +73,7 @@ typedef enum
  * @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
@@ -83,10 +83,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
@@ -154,4 +155,4 @@ int sensor_get_attribute_int(sensor_h sensor, sensor_handle_attribute_e attribut
 }
 #endif
 
-#endif /* __SENSOR_INTERNAL_H__ */
+#endif /* __TIZEN_SYSTEM_SENSOR_INTERNAL_H__ */