sensor: use function properties to document the context

nashif · galak · commit 3d39f72a88b3 · 2021-05-29T08:01:17.000-05:00
We now have function properties which can replace the confusing message in the doxygen docs. Fixes #10499 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
diff --git a/include/drivers/sensor.h b/include/drivers/sensor.h
@@ -451,7 +451,7 @@ static inline int z_impl_sensor_attr_get(const struct device *dev,
  * driver.  It is currently up to the caller to ensure that the handler
  * does not overflow the stack.
  *
- * This API is not permitted for user threads.
+ * @funcprops \supervisor
  *
  * @param dev Pointer to the sensor device
  * @param trig The trigger to activate

Original file line number	Diff line number	Diff line change
`@@ -451,7 +451,7 @@ static inline int z_impl_sensor_attr_get(const struct device *dev,`
`451`	`451`	`* driver. It is currently up to the caller to ensure that the handler`
`452`	`452`	`* does not overflow the stack.`
`453`	`453`	`*`
`454`		`- * This API is not permitted for user threads.`
	`454`	`+ * @funcprops \supervisor`
`455`	`455`	`*`
`456`	`456`	`* @param dev Pointer to the sensor device`
`457`	`457`	`* @param trig The trigger to activate`