From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id C86E08216D for ; Tue, 13 Dec 2016 00:46:43 -0800 (PST) Received: from orsmga004.jf.intel.com ([10.7.209.38]) by orsmga104.jf.intel.com with ESMTP; 13 Dec 2016 00:46:43 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.33,340,1477983600"; d="scan'208";a="39486306" Received: from fmsmsx104.amr.corp.intel.com ([10.18.124.202]) by orsmga004.jf.intel.com with ESMTP; 13 Dec 2016 00:46:43 -0800 Received: from fmsmsx116.amr.corp.intel.com (10.18.116.20) by fmsmsx104.amr.corp.intel.com (10.18.124.202) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 13 Dec 2016 00:46:43 -0800 Received: from shsmsx103.ccr.corp.intel.com (10.239.4.69) by fmsmsx116.amr.corp.intel.com (10.18.116.20) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 13 Dec 2016 00:46:42 -0800 Received: from shsmsx104.ccr.corp.intel.com ([169.254.5.9]) by SHSMSX103.ccr.corp.intel.com ([169.254.4.11]) with mapi id 14.03.0248.002; Tue, 13 Dec 2016 16:46:40 +0800 From: "Yao, Jiewen" To: "Bi, Dandan" , "edk2-devel@lists.01.org" Thread-Topic: [patch 16/18] MdeModulePkg: Make the comments align with the function Thread-Index: AQHSVR0YbCpffjhGKEeaw2xxjhKS/6EFkJkA Date: Tue, 13 Dec 2016 08:46:40 +0000 Message-ID: <74D8A39837DF1E4DA445A8C0B3885C503A8BC490@SHSMSX104.ccr.corp.intel.com> References: <1481618428-101904-1-git-send-email-dandan.bi@intel.com> <1481618428-101904-17-git-send-email-dandan.bi@intel.com> In-Reply-To: <1481618428-101904-17-git-send-email-dandan.bi@intel.com> Accept-Language: zh-CN, en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [patch 16/18] MdeModulePkg: Make the comments align with the function X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 13 Dec 2016 08:46:43 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: jiewen.yao@intel.com > -----Original Message----- > From: Bi, Dandan > Sent: Tuesday, December 13, 2016 4:40 PM > To: edk2-devel@lists.01.org > Cc: Yao, Jiewen > Subject: [patch 16/18] MdeModulePkg: Make the comments align with the > function >=20 > Cc: Jiewen Yao > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Dandan Bi > --- > 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(-) >=20 > 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. >=20 > - @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 >=20 > @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 >=20 > /** > Read a file. >=20 > - @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 >=20 > @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 ( > } >=20 > /** > Sort memory map entries based upon PhysicalStart, from low to high. >=20 > - @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. >=20 > This function need support nested FMP capsule. >=20 > - @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 capsul= e > are processed. >=20 > @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