From: Sami Mujawar <sami.mujawar@arm.com>
To: edk2-devel@lists.01.org
Cc: Arvind Chauhan <Arvind.Chauhan@arm.com>,
Daniil Egranov <Daniil.Egranov@arm.com>,
Thomas Panakamattam Abraham <thomas.abraham@arm.com>,
leif.lindholm@linaro.org, evan.lloyd@arm.com,
Matteo.Carlini@arm.com, Stephanie.Hughes-Fitt@arm.com,
nd@arm.com
Subject: [PATCH edk2-platforms v1 2/6][platforms/devel-dynamictables] Platform/ARM: FVP: Fix function documentation
Date: Wed, 27 Jun 2018 17:48:44 +0100 [thread overview]
Message-ID: <20180627164848.24124-3-sami.mujawar@arm.com> (raw)
In-Reply-To: <20180627164848.24124-1-sami.mujawar@arm.com>
Fixed function documentation issues reported by ecc tool.
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
---
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)'
next prev parent reply other threads:[~2018-06-27 16:48 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-06-27 16:48 [PATCH edk2-platforms v1 0/6][platforms/devel-dynamictables] Fix issues reported by ecc tool Sami Mujawar
2018-06-27 16:48 ` [PATCH edk2-platforms v1 1/6][platforms/devel-dynamictables] Platform/ARM: FVP: Add module info to file header Sami Mujawar
2018-06-27 16:48 ` Sami Mujawar [this message]
2018-06-27 16:48 ` [PATCH edk2-platforms v1 3/6][platforms/devel-dynamictables] Platform/ARM: FVP: Fix variable declaration Sami Mujawar
2018-06-27 16:48 ` [PATCH edk2-platforms v1 4/6][platforms/devel-dynamictables] Platform/ARM: Juno: Add module info to file header Sami Mujawar
2018-06-27 16:48 ` [PATCH edk2-platforms v1 5/6][platforms/devel-dynamictables] Platform/ARM: Juno: Fix function documentation Sami Mujawar
2018-06-27 16:48 ` [PATCH edk2-platforms v1 6/6][platforms/devel-dynamictables] Platform/ARM: Juno: Fix variable declaration Sami Mujawar
2018-06-27 16:58 ` [PATCH edk2-platforms v1 0/6][platforms/devel-dynamictables] Fix issues reported by ecc tool Evan Lloyd
2018-06-28 15:46 ` Leif Lindholm
2018-06-29 12:10 ` Evan Lloyd
2018-07-02 14:01 ` Leif Lindholm
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=20180627164848.24124-3-sami.mujawar@arm.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