public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [PATCH] Silicon/IntelSiliconPkg: Update the comment format
@ 2019-09-06  8:47 Zhang, Shenglei
  2019-09-06  8:47 ` [PATCH] IntelSiliconPkg/SmmAccess: Update the parameters in comments Zhang, Shenglei
                   ` (3 more replies)
  0 siblings, 4 replies; 5+ messages in thread
From: Zhang, Shenglei @ 2019-09-06  8:47 UTC (permalink / raw)
  To: devel; +Cc: Ray Ni, Rangasai V Chaganty

To make the comments in IntelSiliconPkg consistent with those in other
packages, update "@exception" to "@retval" and remove "@result"

Cc: Ray Ni <ray.ni@intel.com>
Cc: Rangasai V Chaganty <rangasai.v.chaganty@intel.com>
Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
---
 .../SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c     | 6 ++----
 .../Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c        | 2 +-
 .../Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h        | 6 ++----
 .../Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h    | 6 ++----
 4 files changed, 7 insertions(+), 13 deletions(-)

diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c
index da141cfa..2310e611 100644
--- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c
+++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLib/PeiSmmAccessLib.c
@@ -234,10 +234,8 @@ GetCapabilities (
 /**
   This function is to install an SMM Access PPI
   - <b>Introduction</b> \n
-    A module to install a PPI for controlling SMM mode memory access basically for S3 resume usage.
-
-  - @result
-    Publish _EFI_PEI_MM_ACCESS_PPI.
+    A module to install a PPI for controlling SMM mode memory access basically for S3 resume usage
+    and publish _EFI_PEI_MM_ACCESS_PPI.
 
     @retval EFI_SUCCESS           - Ppi successfully started and installed.
     @retval EFI_NOT_FOUND         - Ppi can't be found.
diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c
index 3d3c4ab2..bdcacac5 100644
--- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c
+++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.c
@@ -18,7 +18,7 @@ static SMM_ACCESS_PRIVATE_DATA  mSmmAccess;
   @param[in] SystemTable     - Pointer to the EFI System Table
 
   @retval EFI_SUCCESS           - Protocol was installed successfully
-  @exception EFI_UNSUPPORTED    - Protocol was not installed
+  @retval EFI_UNSUPPORTED       - Protocol was not installed
   @retval EFI_NOT_FOUND         - Protocol can't be found.
   @retval EFI_OUT_OF_RESOURCES  - Protocol does not have enough resources to initialize the driver.
 **/
diff --git a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h
index c0ff3a25..647b3a07 100644
--- a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h
+++ b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAccessDriver.h
@@ -58,9 +58,7 @@ typedef struct {
     Finally, the SMM access protocol provides services to "Lock" the SMRAM region.
     Please refer the SMM Protocols section in the attached SMM CIS Specification version 0.9 for further details.
     This driver is required if SMM is supported. Proper configuration of SMM registers is recommended even if SMM is not supported.
-
-  - @result
-    Publishes the _EFI_SMM_ACCESS_PROTOCOL: Documented in the System Management Mode Core Interface Specification, available at the URL: http://www.intel.com/technology/framework/spec.htm
+    This driver publishes the _EFI_SMM_ACCESS_PROTOCOL: Documented in the System Management Mode Core Interface Specification, available at the URL: http://www.intel.com/technology/framework/spec.htm
 
   - <b>Porting Recommendations</b> \n
     No modification of this module is recommended.  Any modification should be done in compliance with the _EFI_SMM_ACCESS_PROTOCOL protocol definition.
@@ -69,7 +67,7 @@ typedef struct {
   @param[in] SystemTable     - Pointer to the EFI System Table
 
   @retval EFI_SUCCESS     - Protocol was installed successfully
-  @exception EFI_UNSUPPORTED - Protocol was not installed
+  @retval EFI_UNSUPPORTED - Protocol was not installed
 **/
 EFI_STATUS
 EFIAPI
diff --git a/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h b/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h
index f658bac6..cf99df56 100644
--- a/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h
+++ b/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h
@@ -11,10 +11,8 @@
 /**
   This function is to install an SMM Access PPI
   - <b>Introduction</b> \n
-    A module to install a PPI for controlling SMM mode memory access basically for S3 resume usage.
-
-  - @result
-    Publish _PEI_MM_ACCESS_PPI.
+    A module to install a PPI for controlling SMM mode memory access basically for S3 resume usage
+    and publish _PEI_MM_ACCESS_PPI.
 
     @retval EFI_SUCCESS           - Ppi successfully started and installed.
     @retval EFI_NOT_FOUND         - Ppi can't be found.
-- 
2.18.0.windows.1


^ permalink raw reply related	[flat|nested] 5+ messages in thread
end of thread, other threads:[~2019-09-06  8:47 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-09-06  8:47 [PATCH] Silicon/IntelSiliconPkg: Update the comment format Zhang, Shenglei
2019-09-06  8:47 ` [PATCH] IntelSiliconPkg/SmmAccess: Update the parameters in comments Zhang, Shenglei
2019-09-06  8:47 ` [PATCH] BoardModulePkg/CmosAccessLib: Remove white ending line Zhang, Shenglei
2019-09-06  8:47 ` [PATCH] UserInterfaceFeaturePkg:Remove white ending line in DSC file Zhang, Shenglei
2019-09-06  8:47 ` [PATCH] DebugFeaturePkg: Remove white space and white ending line Zhang, Shenglei

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox