mirror of
https://github.com/paparazzi/paparazzi.git
synced 2026-05-09 22:49:53 +08:00
[dox] some doxygen fixes
This commit is contained in:
@@ -19,7 +19,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file arch/linux/udp_socket.h
|
||||
* @file arch/linux/udp_socket.c
|
||||
*
|
||||
* Easily create and use UDP sockets.
|
||||
*/
|
||||
|
||||
@@ -39,7 +39,7 @@ struct UdpSocket {
|
||||
|
||||
/**
|
||||
* Create UDP network (in/out sockets).
|
||||
* @param[out] network pointer to already allocated UdpSocket struct
|
||||
* @param[out] sock pointer to already allocated UdpSocket struct
|
||||
* @param[in] host hostname/address
|
||||
* @param[in] port_out output port
|
||||
* @param[in] port_in input port (set to < 0 to disable)
|
||||
@@ -50,7 +50,7 @@ extern int udp_socket_create(struct UdpSocket *sock, char *host, int port_out, i
|
||||
|
||||
/**
|
||||
* Send a packet from buffer, blocking.
|
||||
* @param[in] network pointer to UdpSocket struct
|
||||
* @param[in] sock pointer to UdpSocket struct
|
||||
* @param[in] buffer buffer to send
|
||||
* @param[in] len buffer length in bytes
|
||||
* @return number of bytes sent (-1 on error)
|
||||
@@ -59,7 +59,7 @@ extern int udp_socket_send(struct UdpSocket *sock, uint8_t *buffer, uint16_t len
|
||||
|
||||
/**
|
||||
* Receive a UDP packet, dont wait.
|
||||
* @param[in] network pointer to UdpSocket struct
|
||||
* @param[in] sock pointer to UdpSocket struct
|
||||
* @param[out] buffer buffer to write received packet to
|
||||
* @param[in] len buffer length in bytes
|
||||
* @return number of bytes received (-1 on error)
|
||||
@@ -68,7 +68,7 @@ extern int udp_socket_recv_dontwait(struct UdpSocket *sock, uint8_t *buffer, uin
|
||||
|
||||
/**
|
||||
* Receive one UDP packet.
|
||||
* @param[in] network pointer to UdpSocket struct
|
||||
* @param[in] sock pointer to UdpSocket struct
|
||||
* @param[out] buffer buffer to write received packet to
|
||||
* @param[in] len buffer length in bytes
|
||||
* @return number of bytes received (-1 on error)
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
#include "jpeg.h"
|
||||
|
||||
/**
|
||||
* @file modules/computer_vision/cv/encoding/jpeg.c
|
||||
* @file modules/computer_vision/lib/encoding/jpeg.c
|
||||
* Encode images with the use of the JPEG encoding
|
||||
*/
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||||
|
||||
/**
|
||||
* @file modules/computer_vision/cv/encoding/jpeg.h
|
||||
* @file modules/computer_vision/lib/encoding/jpeg.h
|
||||
* Encode images with the use of the JPEG encoding
|
||||
*/
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file modules/computer_vision/cv/encoding/rtp.c
|
||||
* @file modules/computer_vision/lib/encoding/rtp.c
|
||||
*
|
||||
* Encodes a vide stream with RTP (JPEG)
|
||||
*/
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file modules/computer_vision/cv/encoding/rtp.h
|
||||
* @file modules/computer_vision/lib/encoding/rtp.h
|
||||
*
|
||||
* Encodes a vide stream with RTP (JPEG)
|
||||
*/
|
||||
|
||||
@@ -50,7 +50,7 @@ static void gps_cb(uint8_t sender_id __attribute__((unused)),
|
||||
void ahrs_chimu_register(void)
|
||||
{
|
||||
ahrs_chimu_init();
|
||||
/// @TODO: provide enable function
|
||||
/// @todo: provide enable function
|
||||
ahrs_register_impl(NULL);
|
||||
AbiBindMsgGPS(ABI_BROADCAST, &gps_ev, gps_cb);
|
||||
}
|
||||
|
||||
@@ -35,7 +35,7 @@ struct AhrsChimu ahrs_chimu;
|
||||
void ahrs_chimu_register(void)
|
||||
{
|
||||
ahrs_chimu_init();
|
||||
/// @TODO: provide enable function
|
||||
/// @todo: provide enable function
|
||||
ahrs_register_impl(NULL);
|
||||
}
|
||||
|
||||
|
||||
@@ -71,7 +71,7 @@ static void send_ahrs_ad2(struct transport_tx *trans, struct link_device *dev)
|
||||
void ahrs_ardrone2_register(void)
|
||||
{
|
||||
ahrs_ardrone2_init();
|
||||
/// @TODO: provide enable function
|
||||
/// @todo: provide enable function
|
||||
ahrs_register_impl(NULL);
|
||||
}
|
||||
|
||||
|
||||
@@ -340,7 +340,7 @@ void ahrs_gx3_init(void)
|
||||
void ahrs_gx3_register(void)
|
||||
{
|
||||
ahrs_gx3_init();
|
||||
/// @TODO: provide enable function
|
||||
/// @todo: provide enable function
|
||||
ahrs_register_impl(NULL);
|
||||
}
|
||||
|
||||
|
||||
@@ -87,7 +87,7 @@ void nav_move_waypoint_enu_i(uint8_t wp_id, struct EnuCoor_i *new_pos)
|
||||
|
||||
/**
|
||||
* Set only local XY coordinates of waypoint without update altitude.
|
||||
* @TODO: how to handle global waypoints?
|
||||
* @todo: how to handle global waypoints?
|
||||
*/
|
||||
void nav_set_waypoint_xy_i(uint8_t wp_id, int32_t x, int32_t y)
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user