fix doxygen build

HTRamsey · Feb 3, 2024 · 04901a9 · 04901a9
1 parent 72f57c1
commit 04901a9
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 5 deletions.
diff --git a/source/FreeRTOS_ARP.c b/source/FreeRTOS_ARP.c
@@ -1626,6 +1626,21 @@ void FreeRTOS_ClearARP( const struct xNetworkEndPoint * pxEndPoint )
 #endif /* ( ipconfigHAS_PRINTF != 0 ) || ( ipconfigHAS_DEBUG_PRINTF != 0 ) */
 /*-----------------------------------------------------------*/
 
+/**
+ * @brief Look for pxIPAddress in the ARP cache.
+ *
+ * @param[in,out] pxIPAddress Pointer to the IPv4 or IPv6 address to be queried to the ARP cache.
+ * @param[in,out] pxMACAddress Pointer to a MACAddress_t variable where the MAC address
+ *                          will be stored, if found.
+ * @param[out] ppxEndPoint Pointer to the end-point of the gateway will be stored.
+ *
+ * @return If the IP address exists, copy the associated MAC address into pxMACAddress,
+ *         refresh the ARP cache entry's age, and return eARPCacheHit. If the IP
+ *         address does not exist in the ARP cache return eARPCacheMiss. If the packet
+ *         cannot be sent for any reason (maybe DHCP is still in process, or the
+ *         addressing needs a gateway but there isn't a gateway defined) then return
+ *         eCantSendPacket.
+ */
 eARPLookupResult_t eGetCacheEntry( IPv46_Address_t * pxIPAddress,
                                    MACAddress_t * const pxMACAddress,
                                    struct xNetworkEndPoint ** ppxEndPoint )

diff --git a/source/FreeRTOS_Sockets.c b/source/FreeRTOS_Sockets.c
@@ -4918,7 +4918,7 @@ void vSocketWakeUpUser( FreeRTOS_Socket_t * pxSocket )
  *        For a socket in listening mode, the remote port and IP address
  *        are both 0.
  *
- * @param[in] ulLocalIP Local IP address. Ignored for now.
+ * @param[in] xLocalIP Local IP address. Ignored for now.
  * @param[in] uxLocalPort Local port number.
  * @param[in] xRemoteIP Remote (peer) IP address.
  * @param[in] uxRemotePort Remote (peer) port.

diff --git a/source/FreeRTOS_TCP_IP.c b/source/FreeRTOS_TCP_IP.c
@@ -622,7 +622,7 @@
 /**
  * @brief Process the received TCP packet.
  *
- * @param[in] pxDescriptor The descriptor in which the TCP packet is held.
+ * @param[in] pxNetworkBuffer The descriptor in which the TCP packet is held.
  *
  * @return If the processing of the packet was successful, then pdPASS is returned
  *         or else pdFAIL.

diff --git a/source/include/FreeRTOS_TCP_IP.h b/source/include/FreeRTOS_TCP_IP.h
@@ -38,7 +38,7 @@
  * @brief Process the received TCP packet.
  *
  */
-BaseType_t xProcessReceivedTCPPacket( NetworkBufferDescriptor_t * pxDescriptor );
+BaseType_t xProcessReceivedTCPPacket( NetworkBufferDescriptor_t * pxNetworkBuffer );
 
 typedef enum eTCP_STATE
 {

diff --git a/test/unit-test/FreeRTOS_TCP_IP/TCP_IP_list_macros.h b/test/unit-test/FreeRTOS_TCP_IP/TCP_IP_list_macros.h
@@ -83,7 +83,7 @@ void vSocketWakeUpUser( FreeRTOS_Socket_t * pxSocket );
  * Lookup a TCP socket, using a multiple matching: both port numbers and
  * return IP address.
  */
-FreeRTOS_Socket_t * pxTCPSocketLookup( IPv46_Address_t ulLocalIP,
+FreeRTOS_Socket_t * pxTCPSocketLookup( IPv46_Address_t xLocalIP,
                                        UBaseType_t uxLocalPort,
                                        IPv46_Address_t xRemoteIP,
                                        UBaseType_t uxRemotePort );

diff --git a/test/unit-test/FreeRTOS_TCP_IP_DiffConfig/TCP_IP_DiffConfig_list_macros.h b/test/unit-test/FreeRTOS_TCP_IP_DiffConfig/TCP_IP_DiffConfig_list_macros.h
@@ -83,7 +83,7 @@ void vSocketWakeUpUser( FreeRTOS_Socket_t * pxSocket );
  * Lookup a TCP socket, using a multiple matching: both port numbers and
  * return IP address.
  */
-FreeRTOS_Socket_t * pxTCPSocketLookup( IPv46_Address_t ulLocalIP,
+FreeRTOS_Socket_t * pxTCPSocketLookup( IPv46_Address_t xLocalIP,
                                        UBaseType_t uxLocalPort,
                                        IPv46_Address_t xRemoteIP,
                                        UBaseType_t uxRemotePort );