Fix and simplify newlines in doxygen documentation

Replace '\n' with '<br>', as this allows doxygen to understand reference
names followed by newline. For some cases just drop the newline if it's
not required.

Doxygen 1.8.15 doesn't like if the name of reference is followed by
anything else than (selected?) punctuation or whitespace.

bug #56004
This commit is contained in:
Freddie Chopin 2019-03-26 17:34:01 +01:00 committed by Dirk Ziegelmeier
parent c594599350
commit ec11b289cb
26 changed files with 89 additions and 88 deletions

View File

@ -73,10 +73,10 @@
*
* @defgroup socket Socket API
* @ingroup api
* BSD-style socket API.\n
* Thread-safe, to be called from non-TCPIP threads only.\n
* Can be activated by defining @ref LWIP_SOCKET to 1.\n
* Header is in posix/sys/socket.h\n
* BSD-style socket API.<br>
* Thread-safe, to be called from non-TCPIP threads only.<br>
* Can be activated by defining @ref LWIP_SOCKET to 1.<br>
* Header is in posix/sys/socket.h<br>
* The socket API is a compatibility API for existing applications,
* currently it is built on top of the sequential API. It is meant to
* provide all functions needed to run socket API applications running
@ -212,7 +212,7 @@
/**
* @page mem_err Debugging memory pool sizes
* If you have issues with lwIP and you are using memory pools, check that your pools
* are correctly sized.\n
* are correctly sized.<br>
* To debug pool sizes, \#define LWIP_STATS and MEMP_STATS to 1. Check the global variable
* lwip_stats.memp[] using a debugger. If the "err" member of a pool is > 0, the pool
* may be too small for your application and you need to increase its size.
@ -220,8 +220,8 @@
/**
* @page bugs Reporting bugs
* Please report bugs in the lwIP bug tracker at savannah.\n
* BEFORE submitting, please check if the bug has already been reported!\n
* Please report bugs in the lwIP bug tracker at savannah.<br>
* BEFORE submitting, please check if the bug has already been reported!<br>
* https://savannah.nongnu.org/bugs/?group=lwip
*/
@ -237,12 +237,12 @@
* Use this mode if you do not run an OS on your system. \#define NO_SYS to 1.
* Feed incoming packets to netif->input(pbuf, netif) function from mainloop,
* *not* *from* *interrupt* *context*. You can allocate a @ref pbuf in interrupt
* context and put them into a queue which is processed from mainloop.\n
* Call sys_check_timeouts() periodically in the mainloop.\n
* context and put them into a queue which is processed from mainloop.<br>
* Call sys_check_timeouts() periodically in the mainloop.<br>
* Porting: implement all functions in @ref sys_time, @ref sys_prot and
* @ref compiler_abstraction.\n
* You can only use @ref callbackstyle_api in this mode.\n
* Sample code:\n
* @ref compiler_abstraction.<br>
* You can only use @ref callbackstyle_api in this mode.<br>
* Sample code:
* @include NO_SYS_SampleCode.c
*/
@ -251,8 +251,8 @@
* @ingroup lwip
* Use this mode if you run an OS on your system. It is recommended to
* use an RTOS that correctly handles priority inversion and
* to use @ref LWIP_TCPIP_CORE_LOCKING.\n
* Porting: implement all functions in @ref sys_layer.\n
* to use @ref LWIP_TCPIP_CORE_LOCKING.<br>
* Porting: implement all functions in @ref sys_layer.<br>
* You can use @ref callbackstyle_api together with @ref tcpip_callback,
* and all @ref sequential_api.
*/

View File

@ -5,7 +5,7 @@
* @defgroup netbuf Network buffers
* @ingroup netconn
* Network buffer descriptor for @ref netconn. Based on @ref pbuf internally
* to avoid copying data around.\n
* to avoid copying data around.<br>
* Buffers must not be shared accross multiple threads, all functions except
* netbuf_new() and netbuf_delete() are not thread-safe.
*/

View File

@ -5,8 +5,8 @@
* @defgroup mdns MDNS
* @ingroup apps
*
* RFC 6762 - Multicast DNS\n
* RFC 6763 - DNS-Based Service Discovery\n
* RFC 6762 - Multicast DNS<br>
* RFC 6763 - DNS-Based Service Discovery
*
* You need to increase MEMP_NUM_SYS_TIMEOUT by one if you use MDNS!
*

View File

@ -36,14 +36,14 @@
/**
* @defgroup snmp SNMPv2c/v3 agent
* @ingroup apps
* SNMPv2c and SNMPv3 compatible agent\n
* SNMPv2c and SNMPv3 compatible agent<br>
* There is also a MIB compiler and a MIB viewer in lwIP/contrib subdir
* (lwip/contrib/apps/LwipMibCompiler).\n
* (lwip/contrib/apps/LwipMibCompiler).<br>
* The agent implements the most important MIB2 MIBs including IPv6 support
* (interfaces, UDP, TCP, SNMP, ICMP, SYSTEM). IP MIB is an older version
* without IPv6 statistics (TODO).\n
* without IPv6 statistics (TODO).<br>
* Rewritten by Martin Hentschel <info@cl-soft.de> and
* Dirk Ziegelmeier <dziegel@gmx.de>\n
* Dirk Ziegelmeier <dziegel@gmx.de>
*
* 0 Agent Capabilities
* ====================

View File

@ -1,6 +1,6 @@
/**
* @file
* Application layered TCP connection API (to be used from TCPIP thread)\n
* Application layered TCP connection API (to be used from TCPIP thread)<br>
* This interface mimics the tcp callback API to the application while preventing
* direct linking (much like virtual functions).
* This way, an application can make use of other application layer protocols

View File

@ -1,6 +1,7 @@
/**
* @file
* Application layered TCP connection API (to be used from TCPIP thread)\n
* Application layered TCP connection API (to be used from TCPIP thread)
*
* This interface mimics the tcp callback API to the application while preventing
* direct linking (much like virtual functions).
* This way, an application can make use of other application layer protocols

View File

@ -1,6 +1,6 @@
/**
* @file
* Internet checksum functions.\n
* Internet checksum functions.
*
* These are some reference implementations of the checksum algorithm, with the
* aim of being simple, correct and fully portable. Checksumming is the

View File

@ -16,8 +16,8 @@
* - only start requests if a valid local address is available on the netif
* - only start information requests if required (not for every RA)
*
* dhcp6_enable_stateful() enables stateful DHCPv6 for a netif (stateless disabled)\n
* dhcp6_enable_stateless() enables stateless DHCPv6 for a netif (stateful disabled)\n
* dhcp6_enable_stateful() enables stateful DHCPv6 for a netif (stateless disabled)<br>
* dhcp6_enable_stateless() enables stateless DHCPv6 for a netif (stateful disabled)<br>
* dhcp6_disable() disable DHCPv6 for a netif
*
* When enabled, requests are only issued after receipt of RA with the
@ -453,14 +453,14 @@ dhcp6_information_request(struct netif *netif, struct dhcp6 *dhcp6)
{
const u16_t requested_options[] = {
#if LWIP_DHCP6_PROVIDE_DNS_SERVERS
DHCP6_OPTION_DNS_SERVERS,
DHCP6_OPTION_DNS_SERVERS,
DHCP6_OPTION_DOMAIN_LIST
#endif
#if LWIP_DHCP6_GET_NTP_SRV
, DHCP6_OPTION_SNTP_SERVERS
#endif
};
u16_t msecs;
struct pbuf *p_out;
u16_t options_out_len;

View File

@ -5,12 +5,12 @@
* @defgroup mld6 MLD6
* @ingroup ip6
* Multicast listener discovery for IPv6. Aims to be compliant with RFC 2710.
* No support for MLDv2.\n
* No support for MLDv2.<br>
* Note: The allnodes (ff01::1, ff02::1) group is assumed be received by your
* netif since it must always be received for correct IPv6 operation (e.g. SLAAC).
* Ensure the netif filters are configured accordingly!\n
* Ensure the netif filters are configured accordingly!<br>
* The netif flags also need NETIF_FLAG_MLD6 flag set to enable MLD6 on a
* netif ("netif->flags |= NETIF_FLAG_MLD6;").\n
* netif ("netif->flags |= NETIF_FLAG_MLD6;").<br>
* To be called from TCPIP thread.
*/

View File

@ -267,16 +267,16 @@ netif_add_noaddr(struct netif *netif, void *state, netif_init_fn init, netif_inp
* @param state opaque data passed to the new netif
* @param init callback function that initializes the interface
* @param input callback function that is called to pass
* ingress packets up in the protocol layer stack.\n
* ingress packets up in the protocol layer stack.<br>
* It is recommended to use a function that passes the input directly
* to the stack (netif_input(), NO_SYS=1 mode) or via sending a
* message to TCPIP thread (tcpip_input(), NO_SYS=0 mode).\n
* message to TCPIP thread (tcpip_input(), NO_SYS=0 mode).<br>
* These functions use netif flags NETIF_FLAG_ETHARP and NETIF_FLAG_ETHERNET
* to decide whether to forward to ethernet_input() or ip_input().
* In other words, the functions only work when the netif
* driver is implemented correctly!\n
* driver is implemented correctly!<br>
* Most members of struct netif should be be initialized by the
* netif init function = netif driver (init parameter of this function).\n
* netif init function = netif driver (init parameter of this function).<br>
* IPv6: Don't forget to call netif_create_ip6_linklocal_address() after
* setting the MAC address in struct netif.hwaddr
* (IPv6 requires a link-local address).

View File

@ -2,14 +2,14 @@
* @file
* Implementation of raw protocol PCBs for low-level handling of
* different types of protocols besides (or overriding) those
* already available in lwIP.\n
* already available in lwIP.<br>
* See also @ref raw_raw
*
* @defgroup raw_raw RAW
* @ingroup callbackstyle_api
* Implementation of raw protocol PCBs for low-level handling of
* different types of protocols besides (or overriding) those
* already available in lwIP.\n
* already available in lwIP.<br>
* @see @ref api
*/

View File

@ -5,12 +5,12 @@
*
* @defgroup tcp_raw TCP
* @ingroup callbackstyle_api
* Transmission Control Protocol for IP\n
* Transmission Control Protocol for IP<br>
* @see @ref api
*
* Common functions for the TCP implementation, such as functions
* for manipulating the data structures and the TCP timer functions. TCP functions
* related to input and output is found in tcp_in.c and tcp_out.c respectively.\n
* related to input and output is found in tcp_in.c and tcp_out.c respectively.<br>
*
* TCP connection setup
* --------------------
@ -2540,7 +2540,7 @@ tcp_pcbs_sane(void)
/**
* @defgroup tcp_raw_extargs ext arguments
* @ingroup tcp_raw
* Additional data storage per tcp pcb\n
* Additional data storage per tcp pcb<br>
* @see @ref tcp_raw
*
* When LWIP_TCP_PCB_NUM_EXT_ARGS is > 0, every tcp pcb (including listen pcb)

View File

@ -1,12 +1,12 @@
/**
* @file
* User Datagram Protocol module\n
* The code for the User Datagram Protocol UDP & UDPLite (RFC 3828).\n
* User Datagram Protocol module<br>
* The code for the User Datagram Protocol UDP & UDPLite (RFC 3828).<br>
* See also @ref udp_raw
*
* @defgroup udp_raw UDP
* @ingroup callbackstyle_api
* User Datagram Protocol module\n
* User Datagram Protocol module<br>
* @see @ref api
*/

View File

@ -1,6 +1,6 @@
/**
* @file
* Application layered TCP connection API (to be used from TCPIP thread)\n
* Application layered TCP connection API (to be used from TCPIP thread)
*
* This file contains the generic API.
* For more details see @ref altcp_api.

View File

@ -1,6 +1,6 @@
/**
* @file
* Application layered TCP connection API (to be used from TCPIP thread)\n
* Application layered TCP connection API (to be used from TCPIP thread)<br>
* This interface mimics the tcp callback API to the application while preventing
* direct linking (much like virtual functions).
* This way, an application can make use of other application layer protocols

View File

@ -123,7 +123,7 @@ struct altcp_pcb *altcp_tls_new(struct altcp_tls_config *config, u8_t ip_type);
/** @ingroup altcp_tls
* Create new ALTCP_TLS layer pcb and its inner tcp pcb.
* Same as @ref altcp_tls_new but this allocator function fits to
* @ref altcp_allocator_t / @ref altcp_new.\n
* @ref altcp_allocator_t / @ref altcp_new.<br>
'arg' must contain a struct altcp_tls_config *.
*/
struct altcp_pcb *altcp_tls_alloc(void *arg, u8_t ip_type);

View File

@ -72,7 +72,7 @@
#define LWIP_RAND() ((u32_t)rand())
#endif
/** Platform specific diagnostic output.\n
/** Platform specific diagnostic output.<br>
* Note the default implementation pulls in printf, which may
* in turn pull in a lot of standard libary code. In resource-constrained
* systems, this should be defined to something less resource-consuming.
@ -83,7 +83,7 @@
#include <stdlib.h>
#endif
/** Platform specific assertion handling.\n
/** Platform specific assertion handling.<br>
* Note the default implementation pulls in printf, fflush and abort, which may
* in turn pull in a lot of standard libary code. In resource-constrained
* systems, this should be defined to something less resource-consuming.
@ -261,10 +261,10 @@ typedef int ssize_t;
* its start address using LWIP_MEM_ALIGN.
* You can declare your own version here e.g. to enforce alignment without adding
* trailing padding bytes (see LWIP_MEM_ALIGN_BUFFER) or your own section placement
* requirements.\n
* e.g. if you use gcc and need 32 bit alignment:\n
* \#define LWIP_DECLARE_MEMORY_ALIGNED(variable_name, size) u8_t variable_name[size] \_\_attribute\_\_((aligned(4)))\n
* or more portable:\n
* requirements.<br>
* e.g. if you use gcc and need 32 bit alignment:<br>
* \#define LWIP_DECLARE_MEMORY_ALIGNED(variable_name, size) u8_t variable_name[size] \_\_attribute\_\_((aligned(4)))<br>
* or more portable:<br>
* \#define LWIP_DECLARE_MEMORY_ALIGNED(variable_name, size) u32_t variable_name[(size + sizeof(u32_t) - 1) / sizeof(u32_t)]
*/
#ifndef LWIP_DECLARE_MEMORY_ALIGNED
@ -299,8 +299,8 @@ extern "C" {
#endif
/** Packed structs support.
* Placed BEFORE declaration of a packed struct.\n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
* Placed BEFORE declaration of a packed struct.<br>
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.<br>
* A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
*/
#ifndef PACK_STRUCT_BEGIN
@ -308,8 +308,8 @@ extern "C" {
#endif /* PACK_STRUCT_BEGIN */
/** Packed structs support.
* Placed AFTER declaration of a packed struct.\n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
* Placed AFTER declaration of a packed struct.<br>
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.<br>
* A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
*/
#ifndef PACK_STRUCT_END
@ -317,8 +317,8 @@ extern "C" {
#endif /* PACK_STRUCT_END */
/** Packed structs support.
* Placed between end of declaration of a packed struct and trailing semicolon.\n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
* Placed between end of declaration of a packed struct and trailing semicolon.<br>
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.<br>
* A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
*/
#ifndef PACK_STRUCT_STRUCT
@ -330,8 +330,8 @@ extern "C" {
#endif /* PACK_STRUCT_STRUCT */
/** Packed structs support.
* Wraps u32_t and u16_t members.\n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
* Wraps u32_t and u16_t members.<br>
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.<br>
* A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
*/
#ifndef PACK_STRUCT_FIELD
@ -339,8 +339,8 @@ extern "C" {
#endif /* PACK_STRUCT_FIELD */
/** Packed structs support.
* Wraps u8_t members, where some compilers warn that packing is not necessary.\n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
* Wraps u8_t members, where some compilers warn that packing is not necessary.<br>
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.<br>
* A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
*/
#ifndef PACK_STRUCT_FLD_8
@ -348,20 +348,20 @@ extern "C" {
#endif /* PACK_STRUCT_FLD_8 */
/** Packed structs support.
* Wraps members that are packed structs themselves, where some compilers warn that packing is not necessary.\n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
* Wraps members that are packed structs themselves, where some compilers warn that packing is not necessary.<br>
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.<br>
* A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
*/
#ifndef PACK_STRUCT_FLD_S
#define PACK_STRUCT_FLD_S(x) PACK_STRUCT_FIELD(x)
#endif /* PACK_STRUCT_FLD_S */
/** PACK_STRUCT_USE_INCLUDES==1: Packed structs support using \#include files before and after struct to be packed.\n
* The file included BEFORE the struct is "arch/bpstruct.h".\n
* The file included AFTER the struct is "arch/epstruct.h".\n
/** PACK_STRUCT_USE_INCLUDES==1: Packed structs support using \#include files before and after struct to be packed.<br>
* The file included BEFORE the struct is "arch/bpstruct.h".<br>
* The file included AFTER the struct is "arch/epstruct.h".<br>
* This can be used to implement struct packing on MS Visual C compilers, see
* the Win32 port in the lwIP/contrib subdir for reference.
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder.<br>
* A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
*/
#ifdef __DOXYGEN__

View File

@ -583,8 +583,8 @@ typedef u16_t netif_nsc_reason_t;
#define LWIP_NSC_NETIF_REMOVED 0x0002
/** link changed */
#define LWIP_NSC_LINK_CHANGED 0x0004
/** netif administrative status changed.\n
* up is called AFTER netif is set up.\n
/** netif administrative status changed.<br>
* up is called AFTER netif is set up.<br>
* down is called BEFORE the netif is actually set down. */
#define LWIP_NSC_STATUS_CHANGED 0x0008
/** IPv4 address has changed */

View File

@ -2807,16 +2807,16 @@
* the standardized ISN generation algorithm from RFC 6528 (see contrib/adons/tcp_isn),
* or any other desired algorithm as a replacement.
* Called from tcp_connect() and tcp_listen_input() when an ISN is needed for
* a new TCP connection, if TCP support (@ref LWIP_TCP) is enabled.\n
* a new TCP connection, if TCP support (@ref LWIP_TCP) is enabled.<br>
* Signature:\code{.c}
* u32_t my_hook_tcp_isn(const ip_addr_t* local_ip, u16_t local_port, const ip_addr_t* remote_ip, u16_t remote_port);
* \endcode
* - it may be necessary to use "struct ip_addr" (ip4_addr, ip6_addr) instead of "ip_addr_t" in function declarations\n
* - it may be necessary to use "struct ip_addr" (ip4_addr, ip6_addr) instead of "ip_addr_t" in function declarations<br>
* Arguments:
* - local_ip: pointer to the local IP address of the connection
* - local_port: local port number of the connection (host-byte order)
* - remote_ip: pointer to the remote IP address of the connection
* - remote_port: remote port number of the connection (host-byte order)\n
* - remote_port: remote port number of the connection (host-byte order)<br>
* Return value:
* - the 32-bit Initial Sequence Number to use for the new TCP connection.
*/
@ -3075,16 +3075,16 @@
* LWIP_HOOK_VLAN_SET:
* Hook can be used to set prio_vid field of vlan_hdr. If you need to store data
* on per-netif basis to implement this callback, see @ref netif_cd.
* Called from ethernet_output() if VLAN support (@ref ETHARP_SUPPORT_VLAN) is enabled.\n
* Called from ethernet_output() if VLAN support (@ref ETHARP_SUPPORT_VLAN) is enabled.<br>
* Signature:\code{.c}
* s32_t my_hook_vlan_set(struct netif* netif, struct pbuf* pbuf, const struct eth_addr* src, const struct eth_addr* dst, u16_t eth_type);\n
* s32_t my_hook_vlan_set(struct netif* netif, struct pbuf* pbuf, const struct eth_addr* src, const struct eth_addr* dst, u16_t eth_type);
* \endcode
* Arguments:
* - netif: struct netif that the packet will be sent through
* - p: struct pbuf packet to be sent
* - src: source eth address
* - dst: destination eth address
* - eth_type: ethernet type to packet to be sent\n
* - eth_type: ethernet type to packet to be sent<br>
*
*
* Return values:

View File

@ -1,6 +1,6 @@
/**
* @file
* Application layered TCP connection API (to be used from TCPIP thread)\n
* Application layered TCP connection API (to be used from TCPIP thread)<br>
* This interface mimics the tcp callback API to the application while preventing
* direct linking (much like virtual functions).
* This way, an application can make use of other application layer protocols

View File

@ -1,6 +1,6 @@
/**
* @file
* raw API (to be used from TCPIP thread)\n
* raw API (to be used from TCPIP thread)<br>
* See also @ref raw_raw
*/

View File

@ -1,6 +1,6 @@
/**
* @file
* TCP API (to be used from TCPIP thread)\n
* TCP API (to be used from TCPIP thread)<br>
* See also @ref tcp_raw
*/

View File

@ -1,6 +1,6 @@
/**
* @file
* Base TCP API definitions shared by TCP and ALTCP\n
* Base TCP API definitions shared by TCP and ALTCP<br>
* See also @ref tcp_raw
*/

View File

@ -1,6 +1,6 @@
/**
* @file
* UDP API (to be used from TCPIP thread)\n
* UDP API (to be used from TCPIP thread)<br>
* See also @ref udp_raw
*/

View File

@ -67,7 +67,7 @@ const struct eth_addr ethzero = {{0, 0, 0, 0, 0, 0}};
* @ingroup lwip_nosys
* Process received ethernet frames. Using this function instead of directly
* calling ip_input and passing ARP frames through etharp in ethernetif_input,
* the ARP cache is protected from concurrent access.\n
* the ARP cache is protected from concurrent access.<br>
* Don't call directly, pass to netif_add() and call netif->input().
*
* @param p the received packet, p->payload pointing to the ethernet header

View File

@ -46,12 +46,12 @@
* This is an arch independent SLIP netif. The specific serial hooks must be
* provided by another file. They are sio_open, sio_read/sio_tryread and sio_send
*
* Usage: This netif can be used in three ways:\n
* 1) For NO_SYS==0, an RX thread can be used which blocks on sio_read()
* until data is received.\n
* 2) In your main loop, call slipif_poll() to check for new RX bytes,
* completed packets are fed into netif->input().\n
* 3) Call slipif_received_byte[s]() from your serial RX ISR and
* Usage: This netif can be used in three ways:
* 1. For NO_SYS==0, an RX thread can be used which blocks on sio_read()
* until data is received.
* 2. In your main loop, call slipif_poll() to check for new RX bytes,
* completed packets are fed into netif->input().
* 3. Call slipif_received_byte[s]() from your serial RX ISR and
* slipif_process_rxqueue() from your main loop. ISR level decodes
* packets and puts completed packets on a queue which is fed into
* the stack from the main loop (needs SYS_LIGHTWEIGHT_PROT for