77#ifndef ZEPHYR_INCLUDE_DATA_NAVIGATION_H_
88#define ZEPHYR_INCLUDE_DATA_NAVIGATION_H_
99
10+ /**
11+ * @file
12+ * @brief Header file for navigation data structures.
13+ * @ingroup navigation
14+ */
15+
1016#include <zephyr/types.h>
1117
1218/**
2329 * point relative to a sphere (commonly Earth)
2430 */
2531struct navigation_data {
26- /** Latitudal position in nanodegrees (0 to +-180E9) */
32+ /** Latitudinal position in nanodegrees (0 to +-180E9) */
2733 int64_t latitude ;
28- /** Longitudal position in nanodegrees (0 to +-180E9) */
34+ /** Longitudinal position in nanodegrees (0 to +-180E9) */
2935 int64_t longitude ;
3036 /** Bearing angle in millidegrees (0 to 360E3) */
3137 uint32_t bearing ;
@@ -43,8 +49,8 @@ struct navigation_data {
4349 * @param p1 First navigation point
4450 * @param p2 Second navigation point
4551 *
46- * @return 0 if successful
47- * @return -EINVAL if either navigation point is invalid
52+ * @retval 0 Success
53+ * @retval -EINVAL Either navigation point is invalid
4854 */
4955int navigation_distance (uint64_t * distance , const struct navigation_data * p1 ,
5056 const struct navigation_data * p2 );
@@ -56,8 +62,8 @@ int navigation_distance(uint64_t *distance, const struct navigation_data *p1,
5662 * @param from First navigation point
5763 * @param to Second navigation point
5864 *
59- * @return 0 if successful
60- * @return -EINVAL if either navigation point is invalid
65+ * @retval 0 Success
66+ * @retval -EINVAL Either navigation point is invalid
6167 */
6268int navigation_bearing (uint32_t * bearing , const struct navigation_data * from ,
6369 const struct navigation_data * to );
0 commit comments