sensing: sensing.h: fix doxygen warnings #68317
Conversation
lixuzha
force-pushed
the
fix_doxygen_sensing
branch
from
3db28c7
to
4a878f0
Compare
qianruh
force-pushed
the
fix_doxygen_sensing
branch
from
4a878f0
to
893af4d
Compare
qianruh
force-pushed
the
fix_doxygen_sensing
branch
from
893af4d
to
16183ed
Compare
lixuzha
force-pushed
the
fix_doxygen_sensing
branch
from
16183ed
to
f9d877a
Compare
qianruh
force-pushed
the
fix_doxygen_sensing
branch
2 times, most recently
from
f01abfd
to
c26677b
Compare
|
@kartben can you revisit this please? |
lixuzha
force-pushed
the
fix_doxygen_sensing
branch
4 times, most recently
from
1bee0f5
to
713cbfa
Compare
|
Rebased the PR to latest code. |
|
@kartben Could you help to review this please? |
There was a problem hiding this comment.
thanks a lot for adding documentation here!
General comment is that some of the comments are not really providing explanation/context but O would be happy if only the "suggested changes" were addressed for now ; the rest can be improved at a later date :)
Thanks again!
include/zephyr/sensing/sensing.h
Outdated
| uint32_t interval; /**< Interval of the sensor configuration. */ | ||
| uint32_t sensitivity; /**< Sensitivity of the sensor configuration. */ | ||
| uint64_t latency; /**< Latency of the sensor configuration. */ |
There was a problem hiding this comment.
Rather than "paraphrasing" the name of the attribute, it would be more helpful to also indicate e.g. the unit for each attribute.
Ok, thanks. I'll address them. |
lixuzha
force-pushed
the
fix_doxygen_sensing
branch
from
713cbfa
to
8025909
Compare
Add missing doxygen comments in various sensing headers. Signed-off-by: Zhang Lixu <lixu.zhang@intel.com>
lixuzha
force-pushed
the
fix_doxygen_sensing
branch
from
8025909
to
8f5146b
Compare
Add missing parameter information in
sensing_data_event_t.