From: Dandan Bi <dandan.bi@intel.com>
To: edk2-devel@lists.01.org
Cc: Jiewen Yao <jiewen.yao@intel.com>
Subject: [patch 16/18] MdeModulePkg: Make the comments align with the function
Date: Tue, 13 Dec 2016 16:40:26 +0800 [thread overview]
Message-ID: <1481618428-101904-17-git-send-email-dandan.bi@intel.com> (raw)
In-Reply-To: <1481618428-101904-1-git-send-email-dandan.bi@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
MdeModulePkg/Application/CapsuleApp/AppSupport.c | 10 +++++-----
MdeModulePkg/Application/CapsuleApp/CapsuleDump.c | 6 +++---
MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c | 8 ++++----
MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c | 4 ++--
4 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/MdeModulePkg/Application/CapsuleApp/AppSupport.c b/MdeModulePkg/Application/CapsuleApp/AppSupport.c
index a5fd0ca..edc5f29 100644
--- a/MdeModulePkg/Application/CapsuleApp/AppSupport.c
+++ b/MdeModulePkg/Application/CapsuleApp/AppSupport.c
@@ -348,15 +348,15 @@ ReadFileFromVol (
If ScanFs is FLASE, it will use this Vol as default Fs.
If ScanFs is TRUE, it will scan all FS and check the file.
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
@retval EFI_NO_MAPPING There is duplicated files found
**/
diff --git a/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c b/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
index 3d83ec4..8f44e5e 100644
--- a/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
+++ b/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
@@ -29,13 +29,13 @@
#include <IndustryStandard/WindowsUxCapsule.h>
/**
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
**/
EFI_STATUS
diff --git a/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c b/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
index f8edb78..eba938e 100644
--- a/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
+++ b/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
@@ -144,14 +144,14 @@ 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
SortMemoryMap (
IN OUT EFI_MEMORY_DESCRIPTOR *MemoryMap,
diff --git a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
index 5d46709..3ba3b9c 100644
--- a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
+++ b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
@@ -774,12 +774,12 @@ DumpFmpCapsule (
EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER and
EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER are correct.
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.
@retval EFI_VOLUME_CORRUPTED FV volume in the capsule is corrupted.
@retval EFI_OUT_OF_RESOURCES Not enough memory.
--
1.9.5.msysgit.1
next prev parent reply other threads:[~2016-12-13 8:44 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-13 8:40 [patch 00/18] Fix coding style issues Dandan Bi
2016-12-13 8:40 ` [patch 01/18] ShellPkg/UefiShellDebug1CommandsLib: " Dandan Bi
2016-12-13 16:16 ` Carsey, Jaben
2016-12-13 8:40 ` [patch 02/18] ShellPkg/UefiShellNetwork1CommandsLib: Fix incorrect Protocol format Dandan Bi
2016-12-13 16:16 ` Carsey, Jaben
2016-12-13 8:40 ` [patch 03/18] ShellPkg/UefiShellNetwork2CommandsLib: " Dandan Bi
2016-12-13 16:16 ` Carsey, Jaben
2016-12-13 8:40 ` [patch 04/18] Security:Add info string to UNI file for PcdPkcs7CertBuffer Dandan Bi
[not found] ` <3C0D5C461C9E904E8F62152F6274C0BB3B856DCA@SHSMSX103.ccr.corp.intel.com>
2016-12-14 2:45 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 05/18] SecurityPkg/FmpAuthenticationLibPkcs7: Fix incorrect Guid format Dandan Bi
2016-12-13 8:50 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 06/18] SecurityPkg/FmpAuthenticationLibRsa2048Sha256: Fix Guid/pcd format issues Dandan Bi
2016-12-13 8:50 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 07/18] SecurityPkg/OpalPasswordDxe: Make comments align with the function Dandan Bi
2016-12-14 5:18 ` Dong, Eric
2016-12-13 8:40 ` [patch 08/18] SignedCapsulePkg/EdkiiSystemCapsuleLib: Fix coding style issues in INF file Dandan Bi
2016-12-13 8:49 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 09/18] SignedCapsulePkg/RecoveryModuleLoadPei: Add source file to " Dandan Bi
2016-12-13 8:49 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 10/18] SignedCapsulePkg/SystemFirmwareUpdate: " Dandan Bi
2016-12-13 8:48 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 11/18] SignedCapsulePkg/IniParsingLib: Update struct name Dandan Bi
2016-12-13 8:49 ` Yao, Jiewen
2016-12-14 2:36 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 12/18] UefiCpuPkg: Make the comments align with the functions Dandan Bi
2016-12-14 2:50 ` Fan, Jeff
2016-12-13 8:40 ` [patch 13/18] UefiCpuPkg: Add info string to UNI file for PcdCpuSmmStaticPageTable Dandan Bi
[not found] ` <3C0D5C461C9E904E8F62152F6274C0BB3B856DE3@SHSMSX103.ccr.corp.intel.com>
2016-12-14 2:41 ` Yao, Jiewen
2016-12-14 2:51 ` Fan, Jeff
2016-12-13 8:40 ` [patch 14/18] UefiCpuPkg/MicrocodeUpdateDxe: Fix coding style issues in INF file Dandan Bi
2016-12-13 8:46 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 15/18] UefiCpuPkg/Capsule: Fix coding style issues Dandan Bi
2016-12-13 8:47 ` Yao, Jiewen
2016-12-13 8:40 ` Dandan Bi [this message]
2016-12-13 8:46 ` [patch 16/18] MdeModulePkg: Make the comments align with the function Yao, Jiewen
2016-12-13 8:40 ` [patch 17/18] MdeModulePkg: Add missing info string for PCDs Dandan Bi
[not found] ` <3C0D5C461C9E904E8F62152F6274C0BB3B856DD7@SHSMSX103.ccr.corp.intel.com>
2016-12-14 2:42 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 18/18] MdeModulePkg/CapsuleApp: Fix GUID/protocol format issues Dandan Bi
2016-12-13 8:46 ` Yao, Jiewen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1481618428-101904-17-git-send-email-dandan.bi@intel.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox