Add comments to describe the difference between code and spec to fix the bug #202430

[mirror_edk2.git] / IntelFrameworkPkg / Include / Framework / SmmCis.h

diff --git a/IntelFrameworkPkg/Include/Framework/SmmCis.h b/IntelFrameworkPkg/Include/Framework/SmmCis.h
index d6572d01417b5a468f572460ef915750e3568733..59a660c3a9001d58f825e7190d078b27a3e088cf 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/SmmCis.h
+++ b/IntelFrameworkPkg/Include/Framework/SmmCis.h
@@ -104,7 +104,7 @@ struct _EFI_SMM_CPU_IO_INTERFACE {
   @retval EFI_SUCCESS           The requested number of bytes was allocated.\r
   @retval EFI_OUT_OF_RESOURCES  The pool requested could not be allocated.\r
   @retval EFI_UNSUPPORTED       In runtime.\r
-  @Note: Inconsistent with specification here:\r
+  @note: Inconsistent with specification here:\r
          In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_POOL. However, \r
          To avoid the naming conflict, the definition is renamed.\r
 **/\r
@@ -124,7 +124,7 @@ EFI_STATUS
   @retval EFI_SUCCESS           The memory was returned to the system.\r
   @retval EFI_INVALID_PARAMETER Buffer was invalid.\r
   @retval EFI_UNSUPPORTED       In runtime.\r
-  @Note: Inconsistent with specification here:\r
+  @note: Inconsistent with specification here:\r
          In Framework Spec, This definition is naming EFI_SMM_FREE_POOL However, \r
          To avoid the naming conflict, the definition is renamed.\r
 **/\r
@@ -149,7 +149,7 @@ EFI_STATUS
   @retval EFI_NOT_FOUND         The requested pages could not be found.\r
   @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress\r
                                 or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.\r
-  @Note: Inconsistent with specification here:\r
+  @note: Inconsistent with specification here:\r
          In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_PAGES However, \r
          To avoid the naming conflict, the definition is renamed.\r
 **/\r
@@ -172,7 +172,7 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid.\r
   @retval EFI_NOT_FOUND         The requested memory pages were not allocated with SmmAllocatePages().\r
   \r
-  @Note: Inconsistent with specification here:\r
+  @note: Inconsistent with specification here:\r
          In Framework Spec, This definition is naming EFI_SMM_FREE_PAGES However, \r
          To avoid the naming conflict, the definition is renamed.\r
 **/\r
@@ -197,7 +197,7 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER The CPU requested is not available on this SMI invocation.\r
   @retval EFI_INVALID_PARAMETER The CPU cannot support an additional service invocation.\r
   \r
-  @Note: Inconsistent with specification here:\r
+  @note: Inconsistent with specification here:\r
          In Framework Spec, No this definition. This method is introduced in PI1.0 spec for \r
          implementation needed.\r
          \r