Fixed function documentation issues reported by ecc tool.
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Sami Mujawar <sami.muja...@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)'
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
