diff options
| author | Dandan Bi <dandan.bi@intel.com> | 2016-12-09 10:07:49 +0800 |
|---|---|---|
| committer | Ruiyu Ni <ruiyu.ni@intel.com> | 2016-12-09 11:02:09 +0800 |
| commit | cae7420b4bd015b78f915c4ba766dbee15da0468 (patch) | |
| tree | 6d993ff6a13caf4ba46e3a0cc20e2cb07da40fc0 /FatPkg/EnhancedFatDxe/OpenVolume.c | |
| parent | 6b7e4498e8eb4b3e69472bdadbc5de60d15e0d4d (diff) | |
| download | edk2-cae7420b4bd015b78f915c4ba766dbee15da0468.tar.gz edk2-cae7420b4bd015b78f915c4ba766dbee15da0468.tar.bz2 edk2-cae7420b4bd015b78f915c4ba766dbee15da0468.zip | |
FatPkg/EnhancedFatDxe: Make the comments align with EDKIIcoding style
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
Diffstat (limited to 'FatPkg/EnhancedFatDxe/OpenVolume.c')
| -rw-r--r-- | FatPkg/EnhancedFatDxe/OpenVolume.c | 40 |
1 files changed, 12 insertions, 28 deletions
diff --git a/FatPkg/EnhancedFatDxe/OpenVolume.c b/FatPkg/EnhancedFatDxe/OpenVolume.c index 0f43ffae98..4e12db317e 100644 --- a/FatPkg/EnhancedFatDxe/OpenVolume.c +++ b/FatPkg/EnhancedFatDxe/OpenVolume.c @@ -1,4 +1,5 @@ -/*++
+/** @file
+ OpenVolume() function of Simple File System Protocol.
Copyright (c) 2005 - 2013, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available
@@ -9,45 +10,28 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+**/
-Module Name:
-
- OpenVolume.c
+#include "Fat.h"
-Abstract:
+/**
- OpenVolume() function of Simple File System Protocol
+ Implements Simple File System Protocol interface function OpenVolume().
-Revision History
+ @param This - Calling context.
+ @param File - the Root Directory of the volume.
---*/
-
-#include "Fat.h"
+ @retval EFI_OUT_OF_RESOURCES - Can not allocate the memory.
+ @retval EFI_VOLUME_CORRUPTED - The FAT type is error.
+ @retval EFI_SUCCESS - Open the volume successfully.
+**/
EFI_STATUS
EFIAPI
FatOpenVolume (
IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,
OUT EFI_FILE_PROTOCOL **File
)
-/*++
-
-Routine Description:
-
- Implements Simple File System Protocol interface function OpenVolume().
-
-Arguments:
-
- This - Calling context.
- File - the Root Directory of the volume.
-
-Returns:
-
- EFI_OUT_OF_RESOURCES - Can not allocate the memory.
- EFI_VOLUME_CORRUPTED - The FAT type is error.
- EFI_SUCCESS - Open the volume successfully.
-
---*/
{
EFI_STATUS Status;
FAT_VOLUME *Volume;
|