[Doxygen][components][net]Fix some comments (#7280)
修改了doxygen所报告的一些注释中的问题
This commit is contained in:
hiro_655
GitHub
parent
279825936b
commit
786dce62c4
|
|
@ -1,7 +1,7 @@
|
|||
/*
|
||||
* File : dhcp_server_raw.c
|
||||
* A simple DHCP server implementation
|
||||
* COPYRIGHT (C) 2011-2018, Shanghai Real-Thread Technology Co., Ltd
|
||||
* COPYRIGHT (C) 2011-2023, Shanghai Real-Thread Technology Co., Ltd
|
||||
* http://www.rt-thread.com
|
||||
* All rights reserved.
|
||||
*
|
||||
|
|
@ -161,8 +161,7 @@ dhcp_client_find_by_mac(struct dhcp_server *dhcpserver, const u8_t *chaddr, u8_t
|
|||
* Find a dhcp client node by ip address
|
||||
*
|
||||
* @param dhcpserver The dhcp server
|
||||
* @param chaddr Mac address
|
||||
* @param hlen Mac address length
|
||||
* @param ip IP address
|
||||
* @return dhcp client node
|
||||
*/
|
||||
static struct dhcp_client_node *
|
||||
|
|
@ -182,11 +181,12 @@ dhcp_client_find_by_ip(struct dhcp_server *dhcpserver, const ip4_addr_t *ip)
|
|||
}
|
||||
|
||||
/**
|
||||
* Find a dhcp client node by ip address
|
||||
* Find a dhcp client node by dhcp message
|
||||
*
|
||||
* @param dhcpserver The dhcp server
|
||||
* @param chaddr Mac address
|
||||
* @param hlen Mac address length
|
||||
* @param dhcpserver is the dhcp server
|
||||
* @param msg is the dhcp message
|
||||
* @param opt_buf is the optional buffer
|
||||
* @param len is the buffer length
|
||||
* @return dhcp client node
|
||||
*/
|
||||
static struct dhcp_client_node *
|
||||
|
|
@ -217,11 +217,12 @@ dhcp_client_find(struct dhcp_server *dhcpserver, struct dhcp_msg *msg,
|
|||
}
|
||||
|
||||
/**
|
||||
* Find a dhcp client node by ip address
|
||||
* Allocate a dhcp client node by dhcp message
|
||||
*
|
||||
* @param dhcpserver The dhcp server
|
||||
* @param chaddr Mac address
|
||||
* @param hlen Mac address length
|
||||
* @param dhcpserver is the dhcp server
|
||||
* @param msg is the dhcp message
|
||||
* @param opt_buf is the optional buffer
|
||||
* @param len is the buffer length
|
||||
* @return dhcp client node
|
||||
*/
|
||||
static struct dhcp_client_node *
|
||||
|
|
@ -604,7 +605,7 @@ free_pbuf_and_return:
|
|||
*
|
||||
* @param netif The netif which use dhcp server
|
||||
* @param start The Start IP address
|
||||
* @param end The netif which use dhcp server
|
||||
* @param end The End IP address
|
||||
* @return lwIP error code
|
||||
* - ERR_OK - No error
|
||||
* - ERR_MEM - Out of memory
|
||||
|
|
|
|||
|
|
@ -752,7 +752,6 @@ ip_nat_cmn_init(ip_nat_conf_t *nat_config, const struct ip_hdr *iphdr, ip_nat_en
|
|||
* This function checks for incoming packets if we already have a NAT entry.
|
||||
* If yes a pointer to the NAT entry is returned. Otherwise NULL.
|
||||
*
|
||||
* @param nat_config NAT configuration.
|
||||
* @param iphdr The IP header.
|
||||
* @param udphdr The UDP header.
|
||||
* @return A pointer to an existing NAT entry or
|
||||
|
|
@ -783,6 +782,7 @@ ip_nat_udp_lookup_incoming(const struct ip_hdr *iphdr, const struct udp_hdr *udp
|
|||
* This function checks if we already have a NAT entry for this UDP connection.
|
||||
* If yes the a pointer to this NAT entry is returned.
|
||||
*
|
||||
* @param nat_config NAT config entry
|
||||
* @param iphdr The IP header.
|
||||
* @param udphdr The UDP header.
|
||||
* @param allocate If no existing NAT entry is found and this flag is true
|
||||
|
|
@ -837,7 +837,6 @@ ip_nat_udp_lookup_outgoing(ip_nat_conf_t *nat_config, const struct ip_hdr *iphdr
|
|||
* This function checks for incoming packets if we already have a NAT entry.
|
||||
* If yes a pointer to the NAT entry is returned. Otherwise NULL.
|
||||
*
|
||||
* @param nat_config NAT configuration.
|
||||
* @param iphdr The IP header.
|
||||
* @param tcphdr The TCP header.
|
||||
* @return A pointer to an existing NAT entry or NULL if none is found.
|
||||
|
|
@ -868,6 +867,7 @@ ip_nat_tcp_lookup_incoming(const struct ip_hdr *iphdr, const struct tcp_hdr *tcp
|
|||
* This function checks if we already have a NAT entry for this TCP connection.
|
||||
* If yes the a pointer to this NAT entry is returned.
|
||||
*
|
||||
* @param nat_config NAT config entry
|
||||
* @param iphdr The IP header.
|
||||
* @param tcphdr The TCP header.
|
||||
* @param allocate If no existing NAT entry is found and this flag is true
|
||||
|
|
|
|||
|
|
@ -211,7 +211,7 @@ struct netdev *netdev_get_first_by_flags(uint16_t flags)
|
|||
* This function will get the first network interface device
|
||||
* in network interface device list by IP address.
|
||||
*
|
||||
* @param addr the network interface device IP address
|
||||
* @param ip_addr the network interface device IP address
|
||||
*
|
||||
* @return != NULL: network interface device object
|
||||
* NULL: get failed
|
||||
|
|
@ -456,7 +456,7 @@ int netdev_dhcp_enabled(struct netdev *netdev, rt_bool_t is_enabled)
|
|||
* This function will set network interface device IP address.
|
||||
*
|
||||
* @param netdev the network interface device to change
|
||||
* @param ipaddr the new IP address
|
||||
* @param ip_addr the new IP address
|
||||
*
|
||||
* @return 0: set IP address successfully
|
||||
* -1: set IP address failed
|
||||
|
|
@ -516,7 +516,7 @@ int netdev_set_netmask(struct netdev *netdev, const ip_addr_t *netmask)
|
|||
* This function will set network interface device gateway address.
|
||||
*
|
||||
* @param netdev the network interface device to change
|
||||
* @param gateway the new gateway address
|
||||
* @param gw the new gateway address
|
||||
*
|
||||
* @return 0: set gateway address successfully
|
||||
* -1: set gateway address failed
|
||||
|
|
@ -546,6 +546,7 @@ int netdev_set_gw(struct netdev *netdev, const ip_addr_t *gw)
|
|||
* This function will set network interface device DNS server address.
|
||||
*
|
||||
* @param netdev the network interface device to change
|
||||
* @param dns_num the number of the DNS server
|
||||
* @param dns_server the new DNS server address
|
||||
*
|
||||
* @return 0: set netmask address successfully
|
||||
|
|
@ -606,7 +607,7 @@ void netdev_set_addr_callback(struct netdev *netdev, netdev_callback_fn addr_cal
|
|||
* @NOTE it can only be called in the network interface device driver.
|
||||
*
|
||||
* @param netdev the network interface device to change
|
||||
* @param ipaddr the new IP address
|
||||
* @param ip_addr the new IP address
|
||||
*/
|
||||
void netdev_low_level_set_ipaddr(struct netdev *netdev, const ip_addr_t *ip_addr)
|
||||
{
|
||||
|
|
@ -669,7 +670,7 @@ void netdev_low_level_set_netmask(struct netdev *netdev, const ip_addr_t *netmas
|
|||
* @NOTE it can only be called in the network interface device driver.
|
||||
*
|
||||
* @param netdev the network interface device to change
|
||||
* @param gateway the new gateway address
|
||||
* @param gw the new gateway address
|
||||
*/
|
||||
void netdev_low_level_set_gw(struct netdev *netdev, const ip_addr_t *gw)
|
||||
{
|
||||
|
|
@ -701,6 +702,7 @@ void netdev_low_level_set_gw(struct netdev *netdev, const ip_addr_t *gw)
|
|||
* @NOTE it can only be called in the network interface device driver.
|
||||
*
|
||||
* @param netdev the network interface device to change
|
||||
* @param dns_num the number of the DNS server
|
||||
* @param dns_server the new DNS server address
|
||||
*
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue