From 40a4803fbd8fe1a1b2c44c1f57b8787d09ce5ba6 Mon Sep 17 00:00:00 2001 From: Felix Ruess Date: Tue, 21 Jun 2016 20:37:34 +0200 Subject: [PATCH] [dox] fix some doxygen comments --- .../arch/chibios/mcu_periph/i2c_arch.c | 2 +- .../arch/chibios/mcu_periph/i2c_arch.h | 2 +- .../arch/chibios/modules/core/rtos_mon_arch.h | 2 +- .../delayed_first_order_lowpass_filter.h | 2 +- .../rotorcraft/guidance/guidance_h.h | 8 +-- .../modules/boards/opa_controller_fbw.c | 2 +- .../modules/boards/opa_controller_fbw.h | 2 +- .../computer_vision/lib/vision/edge_flow.c | 2 +- .../computer_vision/lib/vision/edge_flow.h | 2 +- .../modules/digital_cam/catia/protocol.h | 2 +- sw/airborne/modules/ins/xsens700.h | 2 +- sw/airborne/modules/multi/traffic_info.c | 2 +- sw/airborne/modules/multi/traffic_info.h | 58 ++++++++++--------- .../stereocam/stereocam_follow_me/follow_me.c | 2 +- .../stereocam/stereocam_follow_me/follow_me.h | 2 +- sw/airborne/subsystems/intermcu.h | 2 +- sw/simulator/nps/nps_radio_control_joystick.c | 4 +- 17 files changed, 50 insertions(+), 48 deletions(-) diff --git a/sw/airborne/arch/chibios/mcu_periph/i2c_arch.c b/sw/airborne/arch/chibios/mcu_periph/i2c_arch.c index abb146148ba..8606ab52ee3 100644 --- a/sw/airborne/arch/chibios/mcu_periph/i2c_arch.c +++ b/sw/airborne/arch/chibios/mcu_periph/i2c_arch.c @@ -25,7 +25,7 @@ * Boston, MA 02111-1307, USA. */ /** - * @file arch/chibios/subsystems/mcu_periph/i2c_arch.c + * @file arch/chibios/mcu_periph/i2c_arch.c * Interface from Paparazzi I2C to ChibiOS I2C driver * * I2C configuration files are defined in the board file, diff --git a/sw/airborne/arch/chibios/mcu_periph/i2c_arch.h b/sw/airborne/arch/chibios/mcu_periph/i2c_arch.h index 0c117f6feee..985c2961569 100644 --- a/sw/airborne/arch/chibios/mcu_periph/i2c_arch.h +++ b/sw/airborne/arch/chibios/mcu_periph/i2c_arch.h @@ -24,7 +24,7 @@ * Boston, MA 02111-1307, USA. */ /** - * @file arch/chibios/subsystems/mcu_periph/i2c_arch.h + * @file arch/chibios/mcu_periph/i2c_arch.h * Interface from Paparazzi I2C to ChibiOS I2C driver * * I2C configuration files are defined in the board file, diff --git a/sw/airborne/arch/chibios/modules/core/rtos_mon_arch.h b/sw/airborne/arch/chibios/modules/core/rtos_mon_arch.h index 089b3323f63..88b3e06832a 100644 --- a/sw/airborne/arch/chibios/modules/core/rtos_mon_arch.h +++ b/sw/airborne/arch/chibios/modules/core/rtos_mon_arch.h @@ -18,7 +18,7 @@ * . */ /** - * @file "arch/chibios/modules/core/rtos_mon_arh.h" + * @file "arch/chibios/modules/core/rtos_mon_arch.h" * @author Gautier Hattenberger * RTOS monitoring tool * ChibiOS implementation diff --git a/sw/airborne/filters/delayed_first_order_lowpass_filter.h b/sw/airborne/filters/delayed_first_order_lowpass_filter.h index f239a8e1302..20465abd2bc 100644 --- a/sw/airborne/filters/delayed_first_order_lowpass_filter.h +++ b/sw/airborne/filters/delayed_first_order_lowpass_filter.h @@ -19,7 +19,7 @@ * Boston, MA 02111-1307, USA. */ -/** @file filters/delayed_first_order_lowpass.h +/** @file filters/delayed_first_order_lowpass_filter.h * @brief First order low-pass filter with delay * */ diff --git a/sw/airborne/firmwares/rotorcraft/guidance/guidance_h.h b/sw/airborne/firmwares/rotorcraft/guidance/guidance_h.h index e6d84f5c6a9..f3f4b56e1fe 100644 --- a/sw/airborne/firmwares/rotorcraft/guidance/guidance_h.h +++ b/sw/airborne/firmwares/rotorcraft/guidance/guidance_h.h @@ -128,15 +128,15 @@ extern bool guidance_h_set_guided_pos(float x, float y); extern bool guidance_h_set_guided_heading(float heading); /** Set body relative horizontal velocity setpoint in GUIDED mode. - * @param x forward velocity (body frame) in meters/sec. - * @param y right velocity (body frame) in meters/sec. + * @param vx forward velocity (body frame) in meters/sec. + * @param vy right velocity (body frame) in meters/sec. * @return TRUE if setpoints were set (currently in GUIDANCE_H_MODE_GUIDED) */ extern bool guidance_h_set_guided_body_vel(float vx, float vy); /** Set horizontal velocity setpoint in GUIDED mode. - * @param x North velocity (local NED frame) in meters/sec. - * @param y East velocity (local NED frame) in meters/sec. + * @param vx North velocity (local NED frame) in meters/sec. + * @param vy East velocity (local NED frame) in meters/sec. * @return TRUE if setpoints were set (currently in GUIDANCE_H_MODE_GUIDED) */ extern bool guidance_h_set_guided_vel(float vx, float vy); diff --git a/sw/airborne/modules/boards/opa_controller_fbw.c b/sw/airborne/modules/boards/opa_controller_fbw.c index 89c5aaa32ed..cd5ba08f80a 100644 --- a/sw/airborne/modules/boards/opa_controller_fbw.c +++ b/sw/airborne/modules/boards/opa_controller_fbw.c @@ -18,7 +18,7 @@ * . */ /** - * @file "modules/boards/opa_controller.c" + * @file "modules/boards/opa_controller_fbw.c" * @author Freek van Tienen * Controller for OPA board functionalities */ diff --git a/sw/airborne/modules/boards/opa_controller_fbw.h b/sw/airborne/modules/boards/opa_controller_fbw.h index 0a381d2a1d9..80f3165ed7b 100644 --- a/sw/airborne/modules/boards/opa_controller_fbw.h +++ b/sw/airborne/modules/boards/opa_controller_fbw.h @@ -18,7 +18,7 @@ * . */ /** - * @file "modules/boards/opa_controller.h" + * @file "modules/boards/opa_controller_fbw.h" * @author Freek van Tienen * Controller for OPA board functionalities */ diff --git a/sw/airborne/modules/computer_vision/lib/vision/edge_flow.c b/sw/airborne/modules/computer_vision/lib/vision/edge_flow.c index 196fea41e47..7b50cc2caea 100644 --- a/sw/airborne/modules/computer_vision/lib/vision/edge_flow.c +++ b/sw/airborne/modules/computer_vision/lib/vision/edge_flow.c @@ -19,7 +19,7 @@ */ /** - * @file modules/computer_vision/lib/vision/edge_flow.ch + * @file modules/computer_vision/lib/vision/edge_flow.c * @brief calculate optical flow with EdgeFlow * * Edge-histogram matching, implementation by K. N. McGuire diff --git a/sw/airborne/modules/computer_vision/lib/vision/edge_flow.h b/sw/airborne/modules/computer_vision/lib/vision/edge_flow.h index ce5ee942735..596f6b971fd 100644 --- a/sw/airborne/modules/computer_vision/lib/vision/edge_flow.h +++ b/sw/airborne/modules/computer_vision/lib/vision/edge_flow.h @@ -19,7 +19,7 @@ */ /** - * @file modules/computer_vision/lib/vision/edge_flow.ch + * @file modules/computer_vision/lib/vision/edge_flow.h * @brief calculate optical flow with EdgeFlow * * Edge-histogram matching, implementation by K. N. McGuire diff --git a/sw/airborne/modules/digital_cam/catia/protocol.h b/sw/airborne/modules/digital_cam/catia/protocol.h index 9ecee1bc9f2..50c6393ca79 100644 --- a/sw/airborne/modules/digital_cam/catia/protocol.h +++ b/sw/airborne/modules/digital_cam/catia/protocol.h @@ -21,7 +21,7 @@ */ /** - * @file protocol.h + * @file modules/digital_cam/catia/protocol.h * * |STX|length|... payload=(length-4) bytes ...|Checksum A|Checksum B| * diff --git a/sw/airborne/modules/ins/xsens700.h b/sw/airborne/modules/ins/xsens700.h index ef221d76fc4..7d4d919f033 100644 --- a/sw/airborne/modules/ins/xsens700.h +++ b/sw/airborne/modules/ins/xsens700.h @@ -20,7 +20,7 @@ * */ -/** @file modules/ins/xsens_700.h +/** @file modules/ins/xsens700.h * Parser for the Xsens protocol. */ diff --git a/sw/airborne/modules/multi/traffic_info.c b/sw/airborne/modules/multi/traffic_info.c index 1bcb9b91977..a6abd4c2f07 100644 --- a/sw/airborne/modules/multi/traffic_info.c +++ b/sw/airborne/modules/multi/traffic_info.c @@ -18,7 +18,7 @@ * . */ /** - * @file "modules/traffic_info/traffic_info.c" + * @file "modules/multi/traffic_info.c" * @author Kirk Scheper * Information relative to the other aircrafts. * Keeps track of other aircraft in airspace diff --git a/sw/airborne/modules/multi/traffic_info.h b/sw/airborne/modules/multi/traffic_info.h index 9c5958d15cf..6086ef06db3 100644 --- a/sw/airborne/modules/multi/traffic_info.h +++ b/sw/airborne/modules/multi/traffic_info.h @@ -20,7 +20,7 @@ */ /** - * @file "modules/mutli/traffic_info.h" + * @file "modules/multi/traffic_info.h" * @author Kirk Scheper * Keeps track of other aircraft in airspace */ @@ -41,7 +41,7 @@ #endif /** - * @defgroup ac_info Data availability representations + * @defgroup ac_info Aircraft data availability representations * @{ */ #define AC_INFO_POS_UTM_I 0 @@ -165,8 +165,8 @@ extern void set_ac_info_lla(uint8_t id, int32_t lat, int32_t lon, int32_t alt, int16_t course, uint16_t gspeed, int16_t climb, uint32_t itow); /** Set position from UTM coordinates (int). -* @param[in] aircraft id of aircraft info to set -* @param[in] enu_vel velocity in ENU (float) +* @param[in] ac_id aircraft id of aircraft info to set +* @param[in] utm_pos UTM position (int) */ static inline void acInfoSetPositionUtm_i(uint8_t ac_id, struct UtmCoor_i *utm_pos) { @@ -183,8 +183,8 @@ static inline void acInfoSetPositionUtm_i(uint8_t ac_id, struct UtmCoor_i *utm_p } /** Set position from LLA coordinates (int). -* @param[in] aircraft id of aircraft info to set -* @param[in] enu_vel velocity in ENU (float) +* @param[in] ac_id aircraft id of aircraft info to set +* @param[in] lla_pos LLA position (int) */ static inline void acInfoSetPositionLla_i(uint8_t ac_id, struct LlaCoor_i *lla_pos) { @@ -200,8 +200,8 @@ static inline void acInfoSetPositionLla_i(uint8_t ac_id, struct LlaCoor_i *lla_p } } -/** Set velocity from ENU coordinates (int). -* @param[in] aircraft id of aircraft info to set +/** Set position from ENU coordinates (int). +* @param[in] ac_id aircraft id of aircraft info to set * @param[in] enu_pos position in ENU (int) */ static inline void acInfoSetPositionEnu_i(uint8_t ac_id, struct EnuCoor_i *enu_pos) @@ -219,8 +219,8 @@ static inline void acInfoSetPositionEnu_i(uint8_t ac_id, struct EnuCoor_i *enu_p } /** Set position from UTM coordinates (float). -* @param[in] aircraft id of aircraft info to set -* @param[in] enu_vel velocity in ENU (float) +* @param[in] ac_id aircraft id of aircraft info to set +* @param[in] utm_pos UTM position (float) */ static inline void acInfoSetPositionUtm_f(uint8_t ac_id, struct UtmCoor_f *utm_pos) { @@ -237,8 +237,8 @@ static inline void acInfoSetPositionUtm_f(uint8_t ac_id, struct UtmCoor_f *utm_p } /** Set position from LLA coordinates (float). -* @param[in] aircraft id of aircraft info to set -* @param[in] enu_vel velocity in ENU (float) +* @param[in] ac_id aircraft id of aircraft info to set +* @param[in] lla_pos LLA position (float) */ static inline void acInfoSetPositionLla_f(uint8_t ac_id, struct LlaCoor_f *lla_pos) { @@ -254,8 +254,8 @@ static inline void acInfoSetPositionLla_f(uint8_t ac_id, struct LlaCoor_f *lla_p } } -/** Set velocity from ENU coordinates (float). -* @param[in] aircraft id of aircraft info to set +/** Set position from ENU coordinates (float). +* @param[in] ac_id aircraft id of aircraft info to set * @param[in] enu_pos position in ENU (float) */ static inline void acInfoSetPositionEnu_f(uint8_t ac_id, struct EnuCoor_f *enu_pos) @@ -273,7 +273,7 @@ static inline void acInfoSetPositionEnu_f(uint8_t ac_id, struct EnuCoor_f *enu_p } /** Set velocity from ENU coordinates (int). -* @param[in] aircraft id of aircraft info to set +* @param[in] ac_id aircraft id of aircraft info to set * @param[in] enu_vel velocity in ENU (int) */ static inline void acInfoSetVelocityEnu_i(uint8_t ac_id, struct EnuCoor_i *enu_vel) @@ -291,7 +291,7 @@ static inline void acInfoSetVelocityEnu_i(uint8_t ac_id, struct EnuCoor_i *enu_v } /** Set velocity from ENU coordinates (float). - * @param[in] aircraft id of aircraft info to set + * @param[in] ac_id aircraft id of aircraft info to set * @param[in] enu_vel velocity in ENU (float) */ static inline void acInfoSetVelocityEnu_f(uint8_t ac_id, struct EnuCoor_f *enu_vel) @@ -323,7 +323,7 @@ extern void acInfoCalcVelocityEnu_f(uint8_t ac_id); /************************ Get functions ****************************/ /** Get position from UTM coordinates (int). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline struct UtmCoor_i *acInfoGetPositionUtm_i(uint8_t ac_id) { @@ -334,7 +334,7 @@ static inline struct UtmCoor_i *acInfoGetPositionUtm_i(uint8_t ac_id) } /** Get position from LLA coordinates (int). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline struct LlaCoor_i *acInfoGetPositionLla_i(uint8_t ac_id) { @@ -345,7 +345,7 @@ static inline struct LlaCoor_i *acInfoGetPositionLla_i(uint8_t ac_id) } /** Get position in local ENU coordinates (int). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline struct EnuCoor_i *acInfoGetPositionEnu_i(uint8_t ac_id) { @@ -356,7 +356,7 @@ static inline struct EnuCoor_i *acInfoGetPositionEnu_i(uint8_t ac_id) } /** Get position from UTM coordinates (float). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline struct UtmCoor_f *acInfoGetPositionUtm_f(uint8_t ac_id) { @@ -367,7 +367,7 @@ static inline struct UtmCoor_f *acInfoGetPositionUtm_f(uint8_t ac_id) } /** Get position from LLA coordinates (float). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline struct LlaCoor_f *acInfoGetPositionLla_f(uint8_t ac_id) { @@ -378,7 +378,7 @@ static inline struct LlaCoor_f *acInfoGetPositionLla_f(uint8_t ac_id) } /** Get position in local ENU coordinates (float). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline struct EnuCoor_f *acInfoGetPositionEnu_f(uint8_t ac_id) { @@ -389,7 +389,7 @@ static inline struct EnuCoor_f *acInfoGetPositionEnu_f(uint8_t ac_id) } /** Get position from ENU coordinates (int). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline struct EnuCoor_i *acInfoGetVelocityEnu_i(uint8_t ac_id) { @@ -400,7 +400,7 @@ static inline struct EnuCoor_i *acInfoGetVelocityEnu_i(uint8_t ac_id) } /** Get position from ENU coordinates (float). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline struct EnuCoor_f *acInfoGetVelocityEnu_f(uint8_t ac_id) { @@ -411,7 +411,7 @@ static inline struct EnuCoor_f *acInfoGetVelocityEnu_f(uint8_t ac_id) } /** Get vehicle course (float). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline float acInfoGetCourse(uint8_t ac_id) { @@ -419,7 +419,7 @@ static inline float acInfoGetCourse(uint8_t ac_id) } /** Get vehicle ground speed (float). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline float acInfoGetGspeed(uint8_t ac_id) { @@ -427,7 +427,7 @@ static inline float acInfoGetGspeed(uint8_t ac_id) } /** Get vehicle climb speed (float). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline float acInfoGetClimb(uint8_t ac_id) { @@ -435,11 +435,13 @@ static inline float acInfoGetClimb(uint8_t ac_id) } /** Get time of week from latest message (ms). - * @param[in] aircraft id of aircraft info to get + * @param[in] ac_id aircraft id of aircraft info to get */ static inline uint32_t acInfoGetItow(uint8_t ac_id) { return ti_acs[ti_acs_id[ac_id]].itow; } +/** @}*/ + #endif diff --git a/sw/airborne/modules/stereocam/stereocam_follow_me/follow_me.c b/sw/airborne/modules/stereocam/stereocam_follow_me/follow_me.c index 8efa9e398b3..34cbbcdbbcf 100644 --- a/sw/airborne/modules/stereocam/stereocam_follow_me/follow_me.c +++ b/sw/airborne/modules/stereocam/stereocam_follow_me/follow_me.c @@ -5,7 +5,7 @@ * */ /** - * @file modules/stereocam/stereocam_follow_me/stereocam_follow_me.c + * @file modules/stereocam/stereocam_follow_me/follow_me.c * @author Roland * Follows a person using the reference given by the stereocam. * This module does so by changing the yaw angle and roll angle alternatively. diff --git a/sw/airborne/modules/stereocam/stereocam_follow_me/follow_me.h b/sw/airborne/modules/stereocam/stereocam_follow_me/follow_me.h index be6293f73ba..e0e674dc499 100644 --- a/sw/airborne/modules/stereocam/stereocam_follow_me/follow_me.h +++ b/sw/airborne/modules/stereocam/stereocam_follow_me/follow_me.h @@ -5,7 +5,7 @@ * */ /** - * @file modules/stereocam/stereocam_follow_me/stereocam_follow_me.h + * @file modules/stereocam/stereocam_follow_me/follow_me.h * @author Roland * Follows a person using the reference given by the stereocam. * This module does so by changing the yaw angle and roll angle alternatively. diff --git a/sw/airborne/subsystems/intermcu.h b/sw/airborne/subsystems/intermcu.h index ec020c0a544..6869b29642d 100644 --- a/sw/airborne/subsystems/intermcu.h +++ b/sw/airborne/subsystems/intermcu.h @@ -20,7 +20,7 @@ * */ -/** @file subsystems/intermcu/intermcu.h +/** @file subsystems/intermcu.h * @brief Rotorcraft Inter-MCU interface */ diff --git a/sw/simulator/nps/nps_radio_control_joystick.c b/sw/simulator/nps/nps_radio_control_joystick.c index 4ae1af7bbc3..8ba88f438ea 100644 --- a/sw/simulator/nps/nps_radio_control_joystick.c +++ b/sw/simulator/nps/nps_radio_control_joystick.c @@ -123,7 +123,7 @@ SDL_Event sdl_event; * * Function exits with -1 if fails * - * @param device_index string integer of desired joystick device + * @param device string integer of desired joystick device * * @returns 0 on success */ @@ -196,7 +196,7 @@ int nps_radio_control_joystick_init(const char *device) } /** - * Updates joystick buttons from events, directly reads current axis positions.. + * Updates joystick buttons from events, directly reads current axis positions. */ void nps_radio_control_joystick_update(void) {