Skip to content

Commit 80c2cb8

Browse files
kartbennashif
authored andcommitted
drivers: sensor: include: add doxygen for sensor_data_generic_header
Basically just fixing the comment style to use javadoc-style comments so that doxygen picks these up Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 604759e commit 80c2cb8

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

include/zephyr/drivers/sensor.h

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -927,22 +927,23 @@ static inline int z_impl_sensor_channel_get(const struct device *dev,
927927
* Generic data structure used for encoding the sample timestamp and number of channels sampled.
928928
*/
929929
struct __attribute__((__packed__)) sensor_data_generic_header {
930-
/* The timestamp at which the data was collected from the sensor */
930+
/** The timestamp at which the data was collected from the sensor */
931931
uint64_t timestamp_ns;
932932

933933
/*
934-
* The number of channels present in the frame. This will be the true number of elements in
935-
* channel_info and in the q31 values that follow the header.
934+
** The number of channels present in the frame.
935+
* This will be the true number of elements in channel_info and in the q31 values that
936+
* follow the header.
936937
*/
937938
uint32_t num_channels;
938939

939-
/* Shift value for all samples in the frame */
940+
/** Shift value for all samples in the frame */
940941
int8_t shift;
941942

942943
/* This padding is needed to make sure that the 'channels' field is aligned */
943944
int8_t _padding[sizeof(struct sensor_chan_spec) - 1];
944945

945-
/* Channels present in the frame */
946+
/** Channels present in the frame */
946947
struct sensor_chan_spec channels[0];
947948
};
948949

0 commit comments

Comments
 (0)