]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
Formalize comments for Protocols and PPIs.
[mirror_edk2.git] / MdePkg / Include / Protocol / PlatformToDriverConfiguration.h
index 7883028f1000d2a3da794c897cb3f6f435ac9692..0a6429c2066dccd0a988b09b6a1629308362155b 100644 (file)
@@ -253,29 +253,18 @@ EFI_STATUS
 );\r
 \r
 \r
-/**\r
-  @par Protocol Description:\r
-  The EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is used by the\r
-  UEFI driver to query the platform for configuration information.\r
-  The UEFI driver calls Query() multiple times to get\r
-  configuration information from the platform. For every call to\r
-  Query() there must be a matching call to Response() so the\r
-  UEFI driver can inform the platform how it used the\r
-  information passed in from Query(). It's legal for a UEFI\r
-  driver to use Response() to inform the platform it does not\r
-  understand the data returned via Query() and thus no action was\r
-  taken.\r
-\r
-  @param  Query     Called by the UEFI Driver Start() function to\r
-                    get configuration information from the\r
-                    platform.\r
-  \r
-  @param  Response  Called by the UEFI Driver Start() function\r
-                    to let the platform know how UEFI driver\r
-                    processed the data return from Query.\r
-  \r
-\r
-**/\r
+///\r
+/// The EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is used by the\r
+/// UEFI driver to query the platform for configuration information.\r
+/// The UEFI driver calls Query() multiple times to get\r
+/// configuration information from the platform. For every call to\r
+/// Query() there must be a matching call to Response() so the\r
+/// UEFI driver can inform the platform how it used the\r
+/// information passed in from Query(). It's legal for a UEFI\r
+/// driver to use Response() to inform the platform it does not\r
+/// understand the data returned via Query() and thus no action was\r
+/// taken.\r
+///\r
 struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {\r
   EFI_PLATFORM_TO_DRIVER_CONFIGURATION_QUERY    Query;\r
   EFI_PLATFORM_TO_DRIVER_CONFIGURATION_RESPONSE Response;\r