Use doxygen comment style for document entity such as struct, enum, variable that...

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

diff --git a/MdePkg/Include/Protocol/DriverConfiguration.h b/MdePkg/Include/Protocol/DriverConfiguration.h
index 7f10318f9db310aeb8ca0660f73c08d75bb07583..ce94de7f8b902ff108fdac87d5a403aa72e14522 100644 (file)
--- a/MdePkg/Include/Protocol/DriverConfiguration.h
+++ b/MdePkg/Include/Protocol/DriverConfiguration.h
@@ -1,7 +1,7 @@
 /** @file\r
   EFI Driver Configuration Protocol\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -15,11 +15,12 @@
 #ifndef __EFI_DRIVER_CONFIGURATION_H__\r
 #define __EFI_DRIVER_CONFIGURATION_H__\r
 \r
+#include <PiDxe.h>\r
 #include <Protocol/DriverConfiguration2.h>\r
 \r
-//\r
-// Global ID for the Driver Configuration Protocol defined in UEFI 2.0\r
-//\r
+///\r
+/// Global ID for the Driver Configuration Protocol defined in UEFI 2.0\r
+///\r
 #define EFI_DRIVER_CONFIGURATION_PROTOCOL_GUID \\r
   { \\r
     0x107a772b, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
@@ -32,7 +33,7 @@ typedef struct _EFI_DRIVER_CONFIGURATION_PROTOCOL  EFI_DRIVER_CONFIGURATION_PROT
   Allows the user to set controller specific options for a controller that a \r
   driver is currently managing.\r
 \r
-  @param  This             A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL instance.\r
+  @param  This             A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.\r
   @param  ControllerHandle The handle of the controller to set options on.\r
   @param  ChildHandle      The handle of the child controller to set options on.  This\r
                            is an optional parameter that may be NULL.  It will be NULL\r
@@ -72,7 +73,7 @@ typedef struct _EFI_DRIVER_CONFIGURATION_PROTOCOL  EFI_DRIVER_CONFIGURATION_PROT
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DRIVER_CONFIGURATION_SET_OPTIONS) (\r
+(EFIAPI *EFI_DRIVER_CONFIGURATION_SET_OPTIONS)(\r
   IN EFI_DRIVER_CONFIGURATION_PROTOCOL                        *This,\r
   IN  EFI_HANDLE                                              ControllerHandle,\r
   IN  EFI_HANDLE                                              ChildHandle  OPTIONAL,\r
@@ -111,7 +112,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DRIVER_CONFIGURATION_OPTIONS_VALID) (\r
+(EFIAPI *EFI_DRIVER_CONFIGURATION_OPTIONS_VALID)(\r
   IN EFI_DRIVER_CONFIGURATION_PROTOCOL                        *This,\r
   IN  EFI_HANDLE                                              ControllerHandle,\r
   IN  EFI_HANDLE                                              ChildHandle  OPTIONAL\r
@@ -120,7 +121,7 @@ EFI_STATUS
 /**\r
   Forces a driver to set the default configuration options for a controller.\r
 \r
-  @param  This             A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL instance.\r
+  @param  This             A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.\r
   @param  ControllerHandle The handle of the controller to force default configuration options on.\r
   @param  ChildHandle      The handle of the child controller to force default configuration options on  This is an optional parameter that may be NULL.  It will be NULL for device drivers.  It will also be NULL for a bus drivers that wish to force default configuration options for the bus controller.  It will not be NULL for a bus driver that wishes to force default configuration options for one of its child controllers.\r
   @param  DefaultType      The type of default configuration options to force on the controller specified by ControllerHandle and ChildHandle.  See Table 9-1 for legal values.  A DefaultType of 0x00000000 must be supported by this protocol.\r
@@ -138,7 +139,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS) (\r
+(EFIAPI *EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS)(\r
   IN EFI_DRIVER_CONFIGURATION_PROTOCOL                        *This,\r
   IN  EFI_HANDLE                                              ControllerHandle,\r
   IN  EFI_HANDLE                                              ChildHandle  OPTIONAL,\r
@@ -147,15 +148,6 @@ EFI_STATUS
   );\r
 \r
 \r
-//\r
-//\r
-struct _EFI_DRIVER_CONFIGURATION_PROTOCOL {\r
-  EFI_DRIVER_CONFIGURATION_SET_OPTIONS    SetOptions;\r
-  EFI_DRIVER_CONFIGURATION_OPTIONS_VALID  OptionsValid;\r
-  EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS ForceDefaults;\r
-  CHAR8                                   *SupportedLanguages;\r
-};\r
-\r
 /**\r
   Interface structure for the Driver Configuration Protocol.\r
 \r
@@ -176,6 +168,13 @@ struct _EFI_DRIVER_CONFIGURATION_PROTOCOL {
                              codes that this protocol supports.\r
 \r
 **/\r
+struct _EFI_DRIVER_CONFIGURATION_PROTOCOL {\r
+  EFI_DRIVER_CONFIGURATION_SET_OPTIONS    SetOptions;\r
+  EFI_DRIVER_CONFIGURATION_OPTIONS_VALID  OptionsValid;\r
+  EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS ForceDefaults;\r
+  CHAR8                                   *SupportedLanguages;\r
+};\r
+\r
 \r
 extern EFI_GUID gEfiDriverConfigurationProtocolGuid;\r
 \r