Update comments for Protocol definitions to match UEFI spec.

[mirror_edk2.git] / MdePkg / Include / Protocol / Pcd.h

diff --git a/MdePkg/Include/Protocol/Pcd.h b/MdePkg/Include/Protocol/Pcd.h
index 213ca9c6b0cf4d4b04ef8d84e5417b222e154aea..40e436434eaf5e0e87df4dd08e61aa7474824a8c 100644 (file)
--- a/MdePkg/Include/Protocol/Pcd.h
+++ b/MdePkg/Include/Protocol/Pcd.h
@@ -648,10 +648,10 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *PCD_PROTOCOL_SET_EX_POINTER)(\r
-  IN      CONST EFI_GUID    *Guid,\r
-  IN      UINTN             TokenNumber,\r
-  IN OUT  UINTN             *SizeOfBuffer,\r
-  IN      VOID              *Buffer\r
+  IN CONST EFI_GUID          *Guid,\r
+  IN       UINTN             TokenNumber,\r
+  IN OUT   UINTN             *SizeOfBuffer,\r
+  IN       VOID              *Buffer\r
   );\r
 \r
 \r
@@ -706,10 +706,10 @@ EFI_STATUS
 typedef\r
 VOID\r
 (EFIAPI *PCD_PROTOCOL_CALLBACK)(\r
-  IN      CONST EFI_GUID   *CallBackGuid, OPTIONAL\r
-  IN      UINTN            CallBackToken,\r
-  IN  OUT VOID             *TokenData,\r
-  IN      UINTN            TokenDataSize\r
+  IN CONST EFI_GUID         *CallBackGuid, OPTIONAL\r
+  IN       UINTN            CallBackToken,\r
+  IN OUT   VOID             *TokenData,\r
+  IN       UINTN            TokenDataSize\r
   );\r
 \r
 \r
@@ -813,107 +813,9 @@ EFI_STATUS
   IN  OUT    CONST EFI_GUID      **Guid\r
   );\r
 \r
-//\r
-// Interface structure for the PCD Protocol\r
-//\r
-/**\r
-  @par Protocol Description:\r
-  This service abstracts the ability to set/get Platform Configuration Database (PCD).\r
-\r
-  @param SetSku\r
-  Sets the SKU value for subsequent calls to set or get PCD token values.\r
-  \r
-  @param Get8\r
-  Retrieves an 8-bit value for a given PCD token.\r
-\r
-  @param Get16\r
-  Retrieves an 16-bit value for a given PCD token.\r
-\r
-  @param Get32\r
-  Retrieves an 32-bit value for a given PCD token.\r
-\r
-  @param Get64\r
-  Retrieves an 64-bit value for a given PCD token.\r
-\r
-  @param GetPtr\r
-  Retrieves a pointer to a value for a given PCD token.\r
-\r
-  @param GetBool\r
-  Retrieves an Boolean value for a given PCD token.\r
-\r
-  @param GetSize\r
-  Retrieves the size of the value for a given PCD token.\r
-\r
-  @param Get8Ex\r
-  Retrieves an 8-bit value for a given PCD token and token space.\r
-\r
-  @param Get16Ex\r
-  Retrieves an 16-bit value for a given PCD token and token space.\r
-\r
-  @param Get32Ex\r
-  Retrieves an 32-bit value for a given PCD token and token space.\r
-\r
-  @param Get64Ex\r
-  Retrieves an 64-bit value for a given PCD token and token space.\r
-\r
-  @param GetPtrEx\r
-  Retrieves a pointer to a value for a given PCD token and token space.\r
-\r
-  @param GetBoolEx\r
-  Retrieves an Boolean value for a given PCD token and token space.\r
-\r
-  @param GetSizeEx\r
-  Retrieves the size of the value for a given PCD token and token space.\r
-\r
-  @param Set8\r
-  Sets an 8-bit value for a given PCD token.\r
-\r
-  @param Set16\r
-  Sets an 16-bit value for a given PCD token.\r
-\r
-  @param Set32\r
-  Sets an 32-bit value for a given PCD token.\r
-\r
-  @param Set64\r
-  Sets an 64-bit value for a given PCD token.\r
-\r
-  @param SetPtr\r
-  Sets the buffer of a specified size for a given PCD token.\r
-\r
-  @param SetBool\r
-  Sets an Boolean value for a given PCD token.\r
-\r
-  @param Set8Ex\r
-  Sets an 8-bit value for a given PCD token and token space.\r
-\r
-  @param Set16Ex\r
-  Sets an 16-bit value for a given PCD token and token space.\r
-\r
-  @param Set32Ex\r
-  Sets an 32-bit value for a given PCD token and token space.\r
-\r
-  @param Set64Ex\r
-  Sets an 64-bit value for a given PCD token and token space.\r
-\r
-  @param SetPtrEx\r
-  Sets the buffer of a specified size for a given PCD token and token space.\r
-\r
-  @param SetBoolEx\r
-  Sets an Boolean value for a given PCD token and token space.\r
-  \r
-  @param CallbackOnSet\r
-  Specifies a function to be called anytime the value of a designated token is changed.\r
-  \r
-  @param CancelCallback\r
-  Cancels a previously set callback function for a particular PCD token number.\r
-  \r
-  @param GetNextToken\r
-  Retrieves the next valid PCD token for a given namespace.\r
-  \r
-  @param GetNextTokenSpace\r
-  Retrieves the next valid PCD token namespace for a given namespace.\r
- \r
-**/\r
+///\r
+/// This service abstracts the ability to set/get Platform Configuration Database (PCD).\r
+///\r
 typedef struct {\r
   PCD_PROTOCOL_SET_SKU              SetSku;\r
 \r