summaryrefslogtreecommitdiffstats
path: root/FatPkg/EnhancedFatDxe/Delete.c
diff options
context:
space:
mode:
authorDandan Bi <dandan.bi@intel.com>2016-12-09 10:07:49 +0800
committerRuiyu Ni <ruiyu.ni@intel.com>2016-12-09 11:02:09 +0800
commitcae7420b4bd015b78f915c4ba766dbee15da0468 (patch)
tree6d993ff6a13caf4ba46e3a0cc20e2cb07da40fc0 /FatPkg/EnhancedFatDxe/Delete.c
parent6b7e4498e8eb4b3e69472bdadbc5de60d15e0d4d (diff)
downloadedk2-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/Delete.c')
-rw-r--r--FatPkg/EnhancedFatDxe/Delete.c35
1 files changed, 10 insertions, 25 deletions
diff --git a/FatPkg/EnhancedFatDxe/Delete.c b/FatPkg/EnhancedFatDxe/Delete.c
index e5103a850c..9837565a8e 100644
--- a/FatPkg/EnhancedFatDxe/Delete.c
+++ b/FatPkg/EnhancedFatDxe/Delete.c
@@ -1,4 +1,5 @@
-/*++
+/** @file
+ Function that deletes a file.
Copyright (c) 2005 - 2013, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available
@@ -10,41 +11,25 @@ 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:
+**/
- delete.c
-
-Abstract:
+#include "Fat.h"
- Function that deletes a file
+/**
-Revision History
+ Deletes the file & Closes the file handle.
---*/
+ @param FHand - Handle to the file to delete.
-#include "Fat.h"
+ @retval EFI_SUCCESS - Delete the file successfully.
+ @retval EFI_WARN_DELETE_FAILURE - Fail to delete the file.
+**/
EFI_STATUS
EFIAPI
FatDelete (
IN EFI_FILE_PROTOCOL *FHand
)
-/*++
-
-Routine Description:
-
- Deletes the file & Closes the file handle.
-
-Arguments:
-
- FHand - Handle to the file to delete.
-
-Returns:
-
- EFI_SUCCESS - Delete the file successfully.
- EFI_WARN_DELETE_FAILURE - Fail to delete the file.
-
---*/
{
FAT_IFILE *IFile;
FAT_OFILE *OFile;