Skip to content

Commit 58c18fa

Browse files
committed
adding doxygen comments to new functions
1 parent 702d44a commit 58c18fa

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

source/FreeRTOS_IP_Utils.c

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,14 @@ static void prvSetChecksumInPacket( struct xPacketSummary * pxSet,
134134

135135
static uint16_t prvGetChecksumFromPacket( const struct xPacketSummary * pxSet );
136136

137+
/**
138+
* @brief Set checksum in the packet
139+
*
140+
* @param pxSet: Pointer to the packet summary that describes the packet,
141+
* to which the checksum will be set.
142+
*
143+
* @param usChecksum: Checksum value to be set.
144+
*/
137145
static void prvSetChecksumInPacket( struct xPacketSummary * pxSet,
138146
uint16_t usChecksum )
139147
{
@@ -160,6 +168,14 @@ static void prvSetChecksumInPacket( struct xPacketSummary * pxSet,
160168
}
161169
}
162170

171+
/**
172+
* @brief Get checksum from the packet summary
173+
*
174+
* @param pxSet: Pointer to the packet summary that describes the packet,
175+
* from which the checksum will be retrieved.
176+
*
177+
* @return Checksum value that is retrieved from pxSet.
178+
*/
163179
static uint16_t prvGetChecksumFromPacket( const struct xPacketSummary * pxSet )
164180
{
165181
uint16_t usChecksum;

0 commit comments

Comments
 (0)