Skip to content

Commit ec8a45c

Browse files
authored
Fix incorrect Doxygen @param direction for array length parameters (#2165)
Both rawPacketArrLength and packetsArrLength are input parameters (the user provides the allocated array capacity), not output parameters. Fix @param[out] to @param[in].
1 parent 94c9edc commit ec8a45c

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

Pcap++/header/DpdkDevice.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@ namespace pcpp
449449
/// written into. The array is expected to be allocated by the user and its length should be provided in
450450
/// rawPacketArrLength. Number of packets received will be returned. Notice it's the user responsibility to free
451451
/// the array and its content when done using it
452-
/// @param[out] rawPacketArrLength The length of MBufRawPacket pointers array
452+
/// @param[in] rawPacketArrLength The length of MBufRawPacket pointers array
453453
/// @param[in] rxQueueId The RX queue to receive packets from
454454
/// @return The number of packets received. If an error occurred 0 will be returned and the error will be
455455
/// printed to log
@@ -460,7 +460,7 @@ namespace pcpp
460460
/// written into. The array is expected to be allocated by the user and its length should be provided in
461461
/// packetsArrLength. Number of packets received will be returned. Notice it's the user responsibility to free
462462
/// the array and its content when done using it
463-
/// @param[out] packetsArrLength The length of Packet pointers array
463+
/// @param[in] packetsArrLength The length of Packet pointers array
464464
/// @param[in] rxQueueId The RX queue to receive packets from
465465
/// @return The number of packets received. If an error occurred 0 will be returned and the error will be
466466
/// printed to log

0 commit comments

Comments
 (0)