MdeModulePkg: Make the comments align with the function

Cc: Jiewen Yao <jiewen.yao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>

diff --git a/MdeModulePkg/Application/CapsuleApp/AppSupport.c b/MdeModulePkg/Application/CapsuleApp/AppSupport.c
index a5fd0ca3164909af99464386911d8887e9c6e483..edc5f29c47395e96063822b293d3b48a90c55b44 100644 (file)
--- a/MdeModulePkg/Application/CapsuleApp/AppSupport.c
+++ b/MdeModulePkg/Application/CapsuleApp/AppSupport.c
@@ -350,11 +350,11 @@ ReadFileFromVol (
     If there is only one file match the name, it will be read.\r
     If there is more than one file match the name, it will return Error.\r
 \r
-  @param[in]  ThisVol         File System Volume\r
-  @param[in]  FileName        The file to be read.\r
-  @param[out] BufferSize      The file buffer size\r
-  @param[out] Buffer          The file buffer\r
-  @param[in]  ScanFs          Need Scan all FS\r
+  @param[in,out]  ThisVol         File System Volume\r
+  @param[in]      FileName        The file to be read.\r
+  @param[out]     BufferSize      The file buffer size\r
+  @param[out]     Buffer          The file buffer\r
+  @param[in]      ScanFs          Need Scan all FS\r
 \r
   @retval EFI_SUCCESS    Read file successfully\r
   @retval EFI_NOT_FOUND  File not found\r

diff --git a/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c b/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
index 3d83ec4498a3b5eddca4982cb046de83430eaa86..8f44e5e1efb4108cfea3f24ad7edf37ab3788d1d 100644 (file)
--- a/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
+++ b/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
@@ -31,9 +31,9 @@
 /**\r
   Read a file.\r
 \r
-  @param[in] FileName        The file to be read.\r
-  @param[in] BufferSize      The file buffer size\r
-  @param[in] Buffer          The file buffer\r
+  @param[in]  FileName        The file to be read.\r
+  @param[out] BufferSize      The file buffer size\r
+  @param[out] Buffer          The file buffer\r
 \r
   @retval EFI_SUCCESS    Read file successfully\r
   @retval EFI_NOT_FOUND  File not found\r

diff --git a/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c b/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
index f8edb78157380f19c416a482cfdb1b08de612283..eba938e2a92b8334b7b4f7f89556eeacc31274b3 100644 (file)
--- a/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
+++ b/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
@@ -146,10 +146,10 @@ SmmMemoryAttributesTableConsistencyCheck (
 /**\r
   Sort memory map entries based upon PhysicalStart, from low to high.\r
 \r
-  @param[in]  MemoryMap              A pointer to the buffer in which firmware places\r
-                                 the current memory map.\r
-  @param[in]  MemoryMapSize          Size, in bytes, of the MemoryMap buffer.\r
-  @param[in]  DescriptorSize         Size, in bytes, of an individual EFI_MEMORY_DESCRIPTOR.\r
+  @param[in,out]  MemoryMap         A pointer to the buffer in which firmware places\r
+                                    the current memory map.\r
+  @param[in]      MemoryMapSize     Size, in bytes, of the MemoryMap buffer.\r
+  @param[in]      DescriptorSize    Size, in bytes, of an individual EFI_MEMORY_DESCRIPTOR.\r
 **/\r
 STATIC\r
 VOID\r

diff --git a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
index 5d4670997c49ab6f37cdaf5326dca6dccfef5804..3ba3b9c9ccd20e1dd22d66815ba3d317917bd4a8 100644 (file)
--- a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
+++ b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
@@ -776,8 +776,8 @@ DumpFmpCapsule (
 \r
   This function need support nested FMP capsule.\r
 \r
-  @param[in]  CapsuleHeader         Points to a capsule header.\r
-  @param[in]  AreAllImagesProcessed If all the FMP images in the capsule are processed.\r
+  @param[in]   CapsuleHeader         Points to a capsule header.\r
+  @param[out]  AreAllImagesProcessed If all the FMP images in the capsule are processed.\r
 \r
   @retval EFI_SUCESS            Process Capsule Image successfully.\r
   @retval EFI_UNSUPPORTED       Capsule image is not supported by the firmware.\r