From: jcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Wed, 10 Jun 2009 17:51:13 +0000 (+0000)
Subject: updated comments
X-Git-Tag: edk2-stable201903~17766
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=05ef5a882137d609bfbdfd8619dbf19f6c1f6b06

updated comments

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8513 6f19259b-4bc3-4df7-8a09-765794883524
---

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
index 55b360ce18..9bcd093c6c 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
@@ -13,7 +13,7 @@
   Module Name:  SmmSwDispatch.h
 
   @par Revision Reference:
-  This Protocol is defined in Framework of EFI SMM Core Interface Spec
+  This Protocol is defined in Framework for EFI SMM Core Interface Spec
   Version 0.9.
 
 **/
@@ -125,22 +125,21 @@ EFI_STATUS
 /**
   @par Protocol Description:
   Provides the parent dispatch service for a given SMI source generator.
-
-  @param Register
-  Installs a child service to be dispatched by this protocol.
-
-  @param UnRegister
-  Removes a child service dispatched by this protocol.
-
-  @param MaximumSwiValue
-  A read-only field that describes the maximum value that can be used
-  in the EFI_SMM_SW_DISPATCH_PROTOCOL.Register() service.
-
 **/
 struct _EFI_SMM_SW_DISPATCH_PROTOCOL {
+///
+/// Installs a child service to be dispatched by this protocol.
+///
   EFI_SMM_SW_REGISTER   Register;
+///
+/// Removes a child service dispatched by this protocol.
+///
   EFI_SMM_SW_UNREGISTER UnRegister;
-  UINTN                 MaximumSwiValue;
+///
+/// A read-only field that describes the maximum value that can be used
+/// in the EFI_SMM_SW_DISPATCH_PROTOCOL.Register() service.
+///
+UINTN                 MaximumSwiValue;
 };
 
 extern EFI_GUID gEfiSmmSwDispatchProtocolGuid;