NetworkPkg/UefiPxeBcDxe: Correct comments to align with the input parameter.

Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=1230

Cc: Fu Siyuan <siyuan.fu@intel.com>
Cc: Ye Ting <ting.ye@intel.com>
Cc: Bi Dandan <dandan.bi@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Wu Jiaxin <jiaxin.wu@intel.com>
Reviewed-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Fu Siyuan <siyuan.fu@intel.com>

2 files changed, 14 insertions, 2 deletions

diff --git a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c
index 9725fb40dd..61d2d59675 100644
--- a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c
+++ b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c
@@ -1,7 +1,7 @@
 /** @file

   Functions implementation related with Mtftp for UefiPxeBc Driver.

 

-  Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>

 

   This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

@@ -109,6 +109,7 @@ PxeBcMtftp6CheckPacket (
   @param[in]      Config         Pointer to EFI_MTFTP6_CONFIG_DATA.

   @param[in]      Filename       Pointer to boot file name.

   @param[in]      BlockSize      Pointer to required block size.

+  @param[in]      WindowSize     Pointer to required window size.

   @param[in, out] BufferSize     Pointer to buffer size.

 

   @retval EFI_SUCCESS        Sucessfully obtained the size of file.

@@ -248,6 +249,7 @@ ON_ERROR:
   @param[in]      Config         Pointer to EFI_MTFTP6_CONFIG_DATA.

   @param[in]      Filename       Pointer to boot file name.

   @param[in]      BlockSize      Pointer to required block size.

+  @param[in]      WindowSize     Pointer to required window size.

   @param[in]      BufferPtr      Pointer to buffer.

   @param[in, out] BufferSize     Pointer to buffer size.

   @param[in]      DontUseBuffer  Indicates whether with a receive buffer.

@@ -416,6 +418,7 @@ PxeBcMtftp6WriteFile (
   @param[in]       Config         Pointer to EFI_MTFTP6_CONFIG_DATA.

   @param[in]       Filename       Pointer to boot file name.

   @param[in]       BlockSize      Pointer to required block size.

+  @param[in]       WindowSize     Pointer to required window size.

   @param[in]       BufferPtr      Pointer to buffer.

   @param[in, out]  BufferSize     Pointer to buffer size.

   @param[in]       DontUseBuffer  Indicates whether to use a receive buffer.

@@ -586,6 +589,7 @@ PxeBcMtftp4CheckPacket (
   @param[in]      Config         Pointer to EFI_MTFTP4_CONFIG_DATA.

   @param[in]      Filename       Pointer to boot file name.

   @param[in]      BlockSize      Pointer to required block size.

+  @param[in]      WindowSize     Pointer to required window size.

   @param[in, out] BufferSize     Pointer to buffer size.

 

   @retval EFI_SUCCESS        Successfully obtained the size of file.

@@ -725,6 +729,7 @@ ON_ERROR:
   @param[in]      Config         Pointer to EFI_MTFTP4_CONFIG_DATA.

   @param[in]      Filename       Pointer to boot file name.

   @param[in]      BlockSize      Pointer to required block size.

+  @param[in]      WindowSize     Pointer to required window size.

   @param[in]      BufferPtr      Pointer to buffer.

   @param[in, out] BufferSize     Pointer to buffer size.

   @param[in]      DontUseBuffer  Indicates whether to use a receive buffer.

@@ -892,6 +897,7 @@ PxeBcMtftp4WriteFile (
   @param[in]       Config         Pointer to EFI_MTFTP4_CONFIG_DATA.

   @param[in]       Filename       Pointer to boot file name.

   @param[in]       BlockSize      Pointer to required block size.

+  @param[in]       WindowSize     Pointer to required window size.

   @param[in]       BufferPtr      Pointer to buffer.

   @param[in, out]  BufferSize     Pointer to buffer size.

   @param[in]       DontUseBuffer  Indicates whether to use a receive buffer.

@@ -984,6 +990,7 @@ PxeBcMtftp4ReadDirectory (
   @param[in]      Config         Pointer to configure data.

   @param[in]      Filename       Pointer to boot file name.

   @param[in]      BlockSize      Pointer to required block size.

+  @param[in]      WindowSize     Pointer to required window size.

   @param[in, out] BufferSize     Pointer to buffer size.

 

   @retval EFI_SUCCESS        Successfully obtained the size of file.

@@ -1031,6 +1038,7 @@ PxeBcTftpGetFileSize (
   @param[in]      Config         Pointer to config data.

   @param[in]      Filename       Pointer to boot file name.

   @param[in]      BlockSize      Pointer to required block size.

+  @param[in]      WindowSize     Pointer to required window size.

   @param[in]      BufferPtr      Pointer to buffer.

   @param[in, out] BufferSize     Pointer to buffer size.

   @param[in]      DontUseBuffer  Indicates whether to use a receive buffer.

@@ -1136,6 +1144,7 @@ PxeBcTftpWriteFile (
   @param[in]       Config         Pointer to config data.

   @param[in]       Filename       Pointer to boot file name.

   @param[in]       BlockSize      Pointer to required block size.

+  @param[in]       WindowSize     Pointer to required window size.

   @param[in]       BufferPtr      Pointer to buffer.

   @param[in, out]  BufferSize     Pointer to buffer size.

   @param[in]       DontUseBuffer  Indicatse whether to use a receive buffer.

diff --git a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h
index edd8decbd8..30d5cfe343 100644
--- a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h
+++ b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h
@@ -1,7 +1,7 @@
 /** @file

   Functions declaration related with Mtftp for UefiPxeBc Driver.

 

-  Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>

 

   This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

@@ -35,6 +35,7 @@
   @param[in]      Config         Pointer to configure data.

   @param[in]      Filename       Pointer to boot file name.

   @param[in]      BlockSize      Pointer to required block size.

+  @param[in]      WindowSize     Pointer to required window size.

   @param[in, out] BufferSize     Pointer to buffer size.

 

   @retval EFI_SUCCESS        Successfully obtained the size of file.

@@ -61,6 +62,7 @@ PxeBcTftpGetFileSize (
   @param[in]      Config         Pointer to config data.

   @param[in]      Filename       Pointer to boot file name.

   @param[in]      BlockSize      Pointer to required block size.

+  @param[in]      WindowSize     Pointer to required window size.

   @param[in]      BufferPtr      Pointer to buffer.

   @param[in, out] BufferSize     Pointer to buffer size.

   @param[in]      DontUseBuffer  Indicates whether to use a receive buffer.

@@ -118,6 +120,7 @@ PxeBcTftpWriteFile (
   @param[in]       Config         Pointer to config data.

   @param[in]       Filename       Pointer to boot file name.

   @param[in]       BlockSize      Pointer to required block size.

+  @param[in]       WindowSize     Pointer to required window size.

   @param[in]       BufferPtr      Pointer to buffer.

   @param[in, out]  BufferSize     Pointer to buffer size.

   @param[in]       DontUseBuffer  Indicates whether with a receive buffer.