NetworkPkg/Library: Fix various typos
Fix various typos in comments and documentation. Cc: Jiaxin Wu <jiaxin.wu@intel.com> Cc: Siyuan Fu <siyuan.fu@intel.com> Cc: Maciej Rabeda <maciej.rabeda@intel.com> Signed-off-by: Antoine Coeur <coeur@gmx.fr> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com> Reviewed-by: Maciej Rabeda <maciej.rabeda@intel.com> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com> Message-Id: <20200207010831.9046-43-philmd@redhat.com>
This commit is contained in:
committed by
mergify[bot]
parent
efb5659334
commit
6deb4baa1f
@@ -425,7 +425,7 @@ HttpFreeHeaderFields (
|
||||
the HTTP request message.
|
||||
@param[in] Url The URL of a remote host.
|
||||
@param[out] RequestMsg Pointer to the created HTTP request message.
|
||||
NULL if any error occured.
|
||||
NULL if any error occurred.
|
||||
@param[out] RequestMsgSize Size of the RequestMsg (in bytes).
|
||||
|
||||
@retval EFI_SUCCESS If HTTP request string was created successfully.
|
||||
|
@@ -403,7 +403,7 @@ IpIoOpen (
|
||||
|
||||
This function is called after IpIoOpen(). The data to be sent is wrapped in
|
||||
Pkt. The IP instance wrapped in IpIo is used for sending by default but can be
|
||||
overriden by Sender. Other sending configs, like source address and gateway
|
||||
overridden by Sender. Other sending configs, like source address and gateway
|
||||
address etc., are specified in OverrideData.
|
||||
|
||||
@param[in, out] IpIo Pointer to an IP_IO instance used for sending IP
|
||||
@@ -508,7 +508,7 @@ IpIoConfigIp (
|
||||
|
||||
This function pairs with IpIoAddIp(). The IpInfo is previously created by
|
||||
IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance
|
||||
will be dstroyed if the RefCnt is zero.
|
||||
will be destroyed if the RefCnt is zero.
|
||||
|
||||
@param[in] IpIo The pointer to the IP_IO instance.
|
||||
@param[in] IpInfo The pointer to the IpInfo to be removed.
|
||||
|
@@ -748,7 +748,7 @@ EFI_STATUS
|
||||
If it has been removed, then restart the traversal from the head.
|
||||
If it hasn't been removed, then continue with the next node directly.
|
||||
This function will end the iterate and return the CallBack's last return value if error happens,
|
||||
or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
|
||||
or return EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
|
||||
|
||||
@param[in] List The head of the list.
|
||||
@param[in] CallBack Pointer to the callback function to destroy one node in the list.
|
||||
|
@@ -200,7 +200,7 @@ TcpIoReset (
|
||||
@param[in] TcpIo The TcpIo wrapping the TCP socket.
|
||||
@param[in] Packet The packet to transmit.
|
||||
|
||||
@retval EFI_SUCCESS The packet is trasmitted.
|
||||
@retval EFI_SUCCESS The packet is transmitted.
|
||||
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
|
||||
@retval EFI_UNSUPPORTED One or more of the control options are not
|
||||
supported in the implementation.
|
||||
@@ -221,14 +221,14 @@ TcpIoTransmit (
|
||||
|
||||
@param[in, out] TcpIo The TcpIo which wraps the socket to be destroyed.
|
||||
@param[in] Packet The buffer to hold the data copy from the socket rx buffer.
|
||||
@param[in] AsyncMode Is this receive asyncronous or not.
|
||||
@param[in] AsyncMode Is this receive asynchronous or not.
|
||||
@param[in] Timeout The time to wait for receiving the amount of data the Packet
|
||||
can hold. Set to NULL for infinite wait.
|
||||
|
||||
@retval EFI_SUCCESS The required amount of data is received from the socket.
|
||||
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
|
||||
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.
|
||||
@retval EFI_OUT_OF_RESOURCES Failed to allocate momery.
|
||||
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
|
||||
@retval EFI_TIMEOUT Failed to receive the required amount of data in the
|
||||
specified time period.
|
||||
@retval Others Other errors as indicated.
|
||||
|
@@ -43,7 +43,7 @@ typedef struct {
|
||||
|
||||
This prototype is used by both receive and sending when calling
|
||||
UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the
|
||||
UDP access point and released by the user. When sending, the user allocates the the NetBuf,
|
||||
UDP access point and released by the user. When sending, the user allocates the NetBuf,
|
||||
which is then provided to the callback as a reference.
|
||||
|
||||
@param[in] Packet The packet received or sent.
|
||||
@@ -197,7 +197,7 @@ BOOLEAN
|
||||
|
||||
@param[in] UdpIo The UDP_IO to cancel packet.
|
||||
@param[in] IoStatus The IoStatus to return to the packet owners.
|
||||
@param[in] ToCancel The select funtion to test whether to cancel this
|
||||
@param[in] ToCancel The select function to test whether to cancel this
|
||||
packet or not.
|
||||
@param[in] Context The opaque parameter to the ToCancel.
|
||||
|
||||
@@ -228,7 +228,7 @@ UdpIoCancelDgrams (
|
||||
@param[in] ImageHandle The image handle for the driver.
|
||||
@param[in] Configure The function to configure the created UDP child.
|
||||
@param[in] UdpVersion The UDP protocol version, UDP4 or UDP6.
|
||||
@param[in] Context The opaque parameter for the Configure funtion.
|
||||
@param[in] Context The opaque parameter for the Configure function.
|
||||
|
||||
@return The newly-created UDP_IO, or NULL if failed.
|
||||
|
||||
|
Reference in New Issue
Block a user