From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=217.140.96.140; helo=cam-smtp0.cambridge.arm.com; envelope-from=sami.mujawar@arm.com; receiver=edk2-devel@lists.01.org Received: from cam-smtp0.cambridge.arm.com (fw-tnat.cambridge.arm.com [217.140.96.140]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 62CD5202E53ED for ; Wed, 27 Jun 2018 09:48:57 -0700 (PDT) Received: from E107187.Emea.Arm.com (E107187.Emea.Arm.com [10.1.206.129]) by cam-smtp0.cambridge.arm.com (8.13.8/8.13.8) with ESMTP id w5RGmrcR010379; Wed, 27 Jun 2018 17:48:55 +0100 From: Sami Mujawar To: edk2-devel@lists.01.org Cc: Arvind Chauhan , Daniil Egranov , Thomas Panakamattam Abraham , leif.lindholm@linaro.org, evan.lloyd@arm.com, Matteo.Carlini@arm.com, Stephanie.Hughes-Fitt@arm.com, nd@arm.com Date: Wed, 27 Jun 2018 17:48:44 +0100 Message-Id: <20180627164848.24124-3-sami.mujawar@arm.com> X-Mailer: git-send-email 2.11.0.windows.3 In-Reply-To: <20180627164848.24124-1-sami.mujawar@arm.com> References: <20180627164848.24124-1-sami.mujawar@arm.com> Subject: [PATCH edk2-platforms v1 2/6][platforms/devel-dynamictables] Platform/ARM: FVP: Fix function documentation X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.26 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 27 Jun 2018 16:48:58 -0000 Fixed function documentation issues reported by ecc tool. Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Sami Mujawar --- Notes: v1: - Fix ecc tool reported issues [SAMI] Platform/ARM/VExpressPkg/ConfigurationManager/ConfigurationManagerDxe/ConfigurationManager.c | 84 ++++++++++---------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/Platform/ARM/VExpressPkg/ConfigurationManager/ConfigurationManagerDxe/ConfigurationManager.c b/Platform/ARM/VExpressPkg/ConfigurationManager/ConfigurationManagerDxe/ConfigurationManager.c index 2e1be34acf49962fd1899d84dec96c8cb9155b2c..a67a09cb6c197a14b376d4a8ef9a90e438efb2bb 100644 --- a/Platform/ARM/VExpressPkg/ConfigurationManager/ConfigurationManagerDxe/ConfigurationManager.c +++ b/Platform/ARM/VExpressPkg/ConfigurationManager/ConfigurationManagerDxe/ConfigurationManager.c @@ -230,7 +230,7 @@ EFI_PLATFORM_REPOSITORY_INFO VExpressPlatRepositoryInfo = { @retval EFI_SUCCESS Success -*/ +**/ STATIC EFI_STATUS EFIAPI @@ -243,16 +243,16 @@ InitializePlatformRepository ( /** Return a GT Block timer frame info list. - @param [in] This Pointer to the Configuration Manager Protocol. - @param [in] CmObjectId The Configuration Manager Object ID. - @param [in] Token A token for identifying the object - @param [out] CmObject Pointer to the Configuration Manager Object - descriptor describing the requested Object. + @param [in] This Pointer to the Configuration Manager Protocol. + @param [in] CmObjectId The Configuration Manager Object ID. + @param [in] Token A token for identifying the object + @param [in, out] CmObject Pointer to the Configuration Manager Object + descriptor describing the requested Object. @retval EFI_SUCCESS Success. @retval EFI_INVALID_PARAMETER A parameter is invalid. @retval EFI_NOT_FOUND The required object information is not found. -*/ +**/ EFI_STATUS EFIAPI GetGTBlockTimerFrameInfo ( @@ -283,17 +283,17 @@ GetGTBlockTimerFrameInfo ( /** Return a standard namespace object. - @param [in] This Pointer to the Configuration Manager Protocol. - @param [in] CmObjectId The Configuration Manager Object ID. - @param [in] Token An optional token identifying the object. If - unused this must be CM_NULL_TOKEN. - @param [out] CmObject Pointer to the Configuration Manager Object - descriptor describing the requested Object. + @param [in] This Pointer to the Configuration Manager Protocol. + @param [in] CmObjectId The Configuration Manager Object ID. + @param [in] Token An optional token identifying the object. If + unused this must be CM_NULL_TOKEN. + @param [in, out] CmObject Pointer to the Configuration Manager Object + descriptor describing the requested Object. @retval EFI_SUCCESS Success. @retval EFI_INVALID_PARAMETER A parameter is invalid. @retval EFI_NOT_FOUND The required object information is not found. -*/ +**/ EFI_STATUS EFIAPI GetStandardNameSpaceObject ( @@ -333,17 +333,17 @@ GetStandardNameSpaceObject ( /** Return an ARM namespace object. - @param [in] This Pointer to the Configuration Manager Protocol. - @param [in] CmObjectId The Configuration Manager Object ID. - @param [in] Token An optional token identifying the object. If - unused this must be CM_NULL_TOKEN. - @param [out] CmObject Pointer to the Configuration Manager Object - descriptor describing the requested Object. + @param [in] This Pointer to the Configuration Manager Protocol. + @param [in] CmObjectId The Configuration Manager Object ID. + @param [in] Token An optional token identifying the object. If + unused this must be CM_NULL_TOKEN. + @param [in, out] CmObject Pointer to the Configuration Manager Object + descriptor describing the requested Object. @retval EFI_SUCCESS Success. @retval EFI_INVALID_PARAMETER A parameter is invalid. @retval EFI_NOT_FOUND The required object information is not found. -*/ +**/ EFI_STATUS EFIAPI GetArmNameSpaceObject ( @@ -414,12 +414,12 @@ GetArmNameSpaceObject ( /** Return an OEM namespace object. - @param [in] This Pointer to the Configuration Manager Protocol. - @param [in] CmObjectId The Configuration Manager Object ID. - @param [in] Token An optional token identifying the object. If - unused this must be CM_NULL_TOKEN. - @param [out] CmObject Pointer to the Configuration Manager Object - descriptor describing the requested Object. + @param [in] This Pointer to the Configuration Manager Protocol. + @param [in] CmObjectId The Configuration Manager Object ID. + @param [in] Token An optional token identifying the object. If + unused this must be CM_NULL_TOKEN. + @param [in, out] CmObject Pointer to the Configuration Manager Object + descriptor describing the requested Object. @retval EFI_SUCCESS Success. @retval EFI_INVALID_PARAMETER A parameter is invalid. @@ -427,7 +427,7 @@ GetArmNameSpaceObject ( @retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration Manager is less than the Object size for the requested object. -*/ +**/ EFI_STATUS EFIAPI GetOemNameSpaceObject ( @@ -465,17 +465,17 @@ GetOemNameSpaceObject ( Configuration Manager Protocol for returning the Configuration Manager Objects. - @param [in] This Pointer to the Configuration Manager Protocol. - @param [in] CmObjectId The Configuration Manager Object ID. - @param [in] Token An optional token identifying the object. If - unused this must be CM_NULL_TOKEN. - @param [out] CmObject Pointer to the Configuration Manager Object - descriptor describing the requested Object. + @param [in] This Pointer to the Configuration Manager Protocol. + @param [in] CmObjectId The Configuration Manager Object ID. + @param [in] Token An optional token identifying the object. If + unused this must be CM_NULL_TOKEN. + @param [in, out] CmObject Pointer to the Configuration Manager Object + descriptor describing the requested Object. @retval EFI_SUCCESS Success. @retval EFI_INVALID_PARAMETER A parameter is invalid. @retval EFI_NOT_FOUND The required object information is not found. -*/ +**/ EFI_STATUS EFIAPI ArmVExpressPlatformGetObject ( @@ -522,15 +522,15 @@ ArmVExpressPlatformGetObject ( Configuration Manager Protocol for updating the Configuration Manager Objects. - @param [in] This Pointer to the Configuration Manager Protocol. - @param [in] CmObjectId The Configuration Manager Object ID. - @param [in] Token An optional token identifying the object. If - unused this must be CM_NULL_TOKEN. - @param [out] CmObject Pointer to the Configuration Manager Object - descriptor describing the Object. + @param [in] This Pointer to the Configuration Manager Protocol. + @param [in] CmObjectId The Configuration Manager Object ID. + @param [in] Token An optional token identifying the object. If + unused this must be CM_NULL_TOKEN. + @param [in] CmObject Pointer to the Configuration Manager Object + descriptor describing the Object. @retval EFI_UNSUPPORTED This operation is not supported. -*/ +**/ EFI_STATUS EFIAPI ArmVExpressPlatformSetObject ( -- 'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'