summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDandan Bi <dandan.bi@intel.com>2016-11-22 15:38:10 +0800
committerStar Zeng <star.zeng@intel.com>2016-12-14 21:34:45 +0800
commit11ee1bc93dfb590ae0c9bd0f0400b8591ad21525 (patch)
tree1e3b59b6d8c2b4b4be3647cfae27616a6633684f
parent499ed484e8ea081ed051fa411161bf43569a75d7 (diff)
downloadedk2-platforms-11ee1bc93dfb590ae0c9bd0f0400b8591ad21525.tar.xz
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>
-rw-r--r--MdeModulePkg/Application/CapsuleApp/AppSupport.c10
-rw-r--r--MdeModulePkg/Application/CapsuleApp/CapsuleDump.c6
-rw-r--r--MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c8
-rw-r--r--MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c4
4 files changed, 14 insertions, 14 deletions
diff --git a/MdeModulePkg/Application/CapsuleApp/AppSupport.c b/MdeModulePkg/Application/CapsuleApp/AppSupport.c
index a5fd0ca316..edc5f29c47 100644
--- 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.
If there is more than one file match the name, it will return Error.
- @param[in] ThisVol File System Volume
- @param[in] FileName The file to be read.
- @param[out] BufferSize The file buffer size
- @param[out] Buffer The file buffer
- @param[in] ScanFs Need Scan all FS
+ @param[in,out] ThisVol File System Volume
+ @param[in] FileName The file to be read.
+ @param[out] BufferSize The file buffer size
+ @param[out] Buffer The file buffer
+ @param[in] ScanFs Need Scan all FS
@retval EFI_SUCCESS Read file successfully
@retval EFI_NOT_FOUND File not found
diff --git a/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c b/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
index 3d83ec4498..8f44e5e1ef 100644
--- a/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
+++ b/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
@@ -31,9 +31,9 @@
/**
Read a file.
- @param[in] FileName The file to be read.
- @param[in] BufferSize The file buffer size
- @param[in] Buffer The file buffer
+ @param[in] FileName The file to be read.
+ @param[out] BufferSize The file buffer size
+ @param[out] Buffer The file buffer
@retval EFI_SUCCESS Read file successfully
@retval EFI_NOT_FOUND File not found
diff --git a/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c b/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
index f8edb78157..eba938e2a9 100644
--- a/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
+++ b/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
@@ -146,10 +146,10 @@ SmmMemoryAttributesTableConsistencyCheck (
/**
Sort memory map entries based upon PhysicalStart, from low to high.
- @param[in] MemoryMap A pointer to the buffer in which firmware places
- the current memory map.
- @param[in] MemoryMapSize Size, in bytes, of the MemoryMap buffer.
- @param[in] DescriptorSize Size, in bytes, of an individual EFI_MEMORY_DESCRIPTOR.
+ @param[in,out] MemoryMap A pointer to the buffer in which firmware places
+ the current memory map.
+ @param[in] MemoryMapSize Size, in bytes, of the MemoryMap buffer.
+ @param[in] DescriptorSize Size, in bytes, of an individual EFI_MEMORY_DESCRIPTOR.
**/
STATIC
VOID
diff --git a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
index 5d4670997c..3ba3b9c9cc 100644
--- a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
+++ b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
@@ -776,8 +776,8 @@ DumpFmpCapsule (
This function need support nested FMP capsule.
- @param[in] CapsuleHeader Points to a capsule header.
- @param[in] AreAllImagesProcessed If all the FMP images in the capsule are processed.
+ @param[in] CapsuleHeader Points to a capsule header.
+ @param[out] AreAllImagesProcessed If all the FMP images in the capsule are processed.
@retval EFI_SUCESS Process Capsule Image successfully.
@retval EFI_UNSUPPORTED Capsule image is not supported by the firmware.