tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add () after function name so that Doxygen can create reference in doc. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7145 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jgong5 2008-12-29 03:49:50 +00:00
parent b9008c87eb
commit ca9d3a9ded
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
MdeModulePkg/Include/Library/UdpIoLib.h
View File

@ -46,15 +46,15 @@ typedef struct {
Prototype called when receiving or sending packets from/to a UDP point. Prototype called when receiving or sending packets from/to a UDP point.
This prototype is used by both receive and sending when calling This prototype is used by both receive and sending when calling
UdpIoRecvDatagram or UdpIoSendDatagram. When receiving, Netbuf is allocated by UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by
UDP access point, and released by user. When sending, the NetBuf is from user, UDP access point, and released by user. When sending, the NetBuf is from user,
and provided to the callback as a reference. and provided to the callback as a reference.
@param Packet Packet received or sent @param Packet Packet received or sent
@param Points The Udp4 address pair corresponds to the Udp4 IO @param Points The Udp4 address pair corresponds to the Udp4 IO
@param IoStatus Packet receiving or sending status @param IoStatus Packet receiving or sending status
@param Context User-defined data when calling UdpIoRecvDatagram or @param Context User-defined data when calling UdpIoRecvDatagram() or
UdpIoSendDatagram UdpIoSendDatagram()
@return None @return None
**/ **/
@ -138,14 +138,14 @@ struct _UDP_IO_PORT {
/** /**
Prototype called when UdpIo Library configures a Udp4 instance. Prototype called when UdpIo Library configures a Udp4 instance.
The prototype is set and called when creating a UDP_IO_PORT in UdpIoCreatePort. The prototype is set and called when creating a UDP_IO_PORT in UdpIoCreatePort().
@param UdpIo The UDP_IO_PORT to configure @param UdpIo The UDP_IO_PORT to configure
@param Context User-defined data when calling UdpIoCreatePort @param Context User-defined data when calling UdpIoCreatePort()
@retval EFI_SUCCESS The configure process succeeds @retval EFI_SUCCESS The configure process succeeds
@retval Others The UDP_IO_PORT fails to configure indicating @retval Others The UDP_IO_PORT fails to configure indicating
UdpIoCreatePort should fail UdpIoCreatePort() should fail
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
@ -158,7 +158,7 @@ EFI_STATUS
The select function to decide whether to cancel the UDP_TX_TOKEN. It is used The select function to decide whether to cancel the UDP_TX_TOKEN. It is used
@param Token The UDP_TX_TOKEN to decide whether to cancel @param Token The UDP_TX_TOKEN to decide whether to cancel
@param Context User-defined data in UdpIoCancelDgrams @param Context User-defined data in UdpIoCancelDgrams()
@retval TRUE To cancel the UDP_TX_TOKEN @retval TRUE To cancel the UDP_TX_TOKEN
@retval FALSE Do not cancel this UDP_TX_TOKEN @retval FALSE Do not cancel this UDP_TX_TOKEN

2
MdeModulePkg/Library/DxeUdpIoLib/DxeUdpIoLib.c
View File

@ -198,7 +198,7 @@ UdpIoOnDgramRcvdDpc (
} }
/** /**
Request UdpIoOnDgramRcvdDpc as a DPC at TPL_CALLBACK. Request UdpIoOnDgramRcvdDpc() as a DPC at TPL_CALLBACK.
@param Event The UDP receive request event. @param Event The UDP receive request event.
@param Context The UDP RX token. @param Context The UDP RX token.