Add comments for most of enum data type.

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

diff --git a/MdePkg/Include/Protocol/DriverConfiguration2.h b/MdePkg/Include/Protocol/DriverConfiguration2.h
index e1597437a93ebf061d5d27df9d8d301b3487a114..360b02b83b750c7203f21a79bbd67a3add5ee21c 100644 (file)
--- a/MdePkg/Include/Protocol/DriverConfiguration2.h
+++ b/MdePkg/Include/Protocol/DriverConfiguration2.h
@@ -26,9 +26,25 @@
 typedef struct _EFI_DRIVER_CONFIGURATION2_PROTOCOL  EFI_DRIVER_CONFIGURATION2_PROTOCOL;\r
 \r
 typedef enum {\r
+  ///\r
+  /// The controller is still in a usable state. No actions\r
+  /// are required before this controller can be used again.\r
+  ///\r
   EfiDriverConfigurationActionNone              = 0,\r
+  ///\r
+  /// The driver has detected that the controller is not in a\r
+  /// usable state, and it needs to be stopped.\r
+  ///\r
   EfiDriverConfigurationActionStopController    = 1,\r
+  ///\r
+  /// This controller needs to be stopped and restarted\r
+  /// before it can be used again.\r
+  ///\r
   EfiDriverConfigurationActionRestartController = 2,\r
+  ///\r
+  /// A configuration change has been made that requires the platform to be restarted before\r
+  /// the controller can be used again.\r
+  ///\r
   EfiDriverConfigurationActionRestartPlatform   = 3,\r
   EfiDriverConfigurationActionMaximum\r
 } EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED;\r