cleaned up lwIP function header javadoc (#441)

Co-authored-by: Steve Karg <skarg@users.sourceforge.net>
This commit is contained in:
Steve Karg
2023-06-28 12:46:56 -05:00
committed by GitHub
parent db21bf1bfa
commit 5b7eac60cf
2 changed files with 19 additions and 3 deletions
+9
View File
@@ -0,0 +1,9 @@
branches:
- label: enhancement
prefix: feature/
- label: bug
prefix: bugfix/
- label: documentation
prefix: chore/
- label: '*'
prefix: issues/
+10 -3
View File
@@ -236,8 +236,7 @@ static int bip_encode_bip_address(BACNET_IP_ADDRESS *baddr,
/** Function to send a packet out the BACnet/IP socket (Annex J).
* @ingroup DLBIP
*
* @param dest [in] Destination address
* @param port [in] UDP port number
* @param dest [in] Destination address and port
* @param mtu_len [in] PBUF packet
* @return number of bytes sent, or 0 on failure.
*/
@@ -318,6 +317,10 @@ void bip_server_callback(void *arg,
pbuf_free(pkt);
}
/**
* @brief Get the BACnet/IP unicast address in full BACnet address format
* @param my_address - pointer to the #BACNET_ADDRESS to fill
*/
void bip_get_my_address(BACNET_ADDRESS *my_address)
{
int i = 0;
@@ -337,8 +340,12 @@ void bip_get_my_address(BACNET_ADDRESS *my_address)
return;
}
/**
* @brief Get the BACnet/IP broadcast address in full BACnet address format
* @param dest - pointer to the #BACNET_ADDRESS to fill
*/
void bip_get_broadcast_address(BACNET_ADDRESS *dest)
{ /* destination address */
{
int i = 0; /* counter */
if (dest) {