]> git.proxmox.com Git - mirror_edk2.git/blobdiff - FatPkg/EnhancedFatDxe/OpenVolume.c
MdeModulePkg/FaultTolerantWriteDxe: implement standalone MM version
[mirror_edk2.git] / FatPkg / EnhancedFatDxe / OpenVolume.c
index 0f43ffae9826d2afc7eca4dab7571fe171ca3b3d..4e12db317eb2d1d6aa566499ea33742cc0029465 100644 (file)
@@ -1,4 +1,5 @@
-/*++\r
+/** @file\r
+  OpenVolume() function of Simple File System Protocol.\r
 \r
 Copyright (c) 2005 - 2013, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available\r
@@ -9,45 +10,28 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
+**/\r
 \r
-Module Name:\r
-\r
-  OpenVolume.c\r
+#include "Fat.h"\r
 \r
-Abstract:\r
+/**\r
 \r
-  OpenVolume() function of Simple File System Protocol\r
+  Implements Simple File System Protocol interface function OpenVolume().\r
 \r
-Revision History\r
+  @param  This                  - Calling context.\r
+  @param  File                  - the Root Directory of the volume.\r
 \r
---*/\r
-\r
-#include "Fat.h"\r
+  @retval EFI_OUT_OF_RESOURCES  - Can not allocate the memory.\r
+  @retval EFI_VOLUME_CORRUPTED  - The FAT type is error.\r
+  @retval EFI_SUCCESS           - Open the volume successfully.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 FatOpenVolume (\r
   IN  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL  *This,\r
   OUT EFI_FILE_PROTOCOL                **File\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Implements Simple File System Protocol interface function OpenVolume().\r
-\r
-Arguments:\r
-\r
-  This                  - Calling context.\r
-  File                  - the Root Directory of the volume.\r
-\r
-Returns:\r
-\r
-  EFI_OUT_OF_RESOURCES  - Can not allocate the memory.\r
-  EFI_VOLUME_CORRUPTED  - The FAT type is error.\r
-  EFI_SUCCESS           - Open the volume successfully.\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
   FAT_VOLUME  *Volume;\r