Add some function/header comments.

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / VgaMiniPort.h

diff --git a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
index bb9802420cb8d40be847c0e7bb1a280cc034a54b..714028993cbe13664ef854b730df505d16cb51d1 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
@@ -22,6 +22,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 typedef struct _EFI_VGA_MINI_PORT_PROTOCOL  EFI_VGA_MINI_PORT_PROTOCOL;\r
 \r
+/**\r
+  Sets the text display mode of a VGA controller\r
+  \r
+  @param This             Protocol instance pointer.\r
+  @param Mode             Mode number.  0 - 80x25   1-80x50\r
+\r
+  @retval EFI_SUCCESS            The mode was set\r
+  @retval EFI_DEVICE_ERROR       The device is not functioning properly.\r
+  \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_VGA_MINI_PORT_SET_MODE) (\r
@@ -29,20 +39,6 @@ EFI_STATUS
   IN UINTN                               ModeNumber\r
   );\r
 \r
-/*++\r
-\r
-  Routine Description:\r
-    Sets the text display mode of a VGA controller\r
-\r
-  Arguments:\r
-    This                 - Protocol instance pointer.\r
-    Mode                 - Mode number.  0 - 80x25   1-80x50\r
-\r
-  Returns:\r
-    EFI_SUCCESS           - The mode was set\r
-    EFI_DEVICE_ERROR      - The device is not functioning properly.\r
-\r
---*/\r
 struct _EFI_VGA_MINI_PORT_PROTOCOL {\r
   EFI_VGA_MINI_PORT_SET_MODE  SetMode;\r
 \r