FatPkg/EnhancedFatDxe: Make the comments align with EDKIIcoding style

[mirror_edk2.git] / FatPkg / EnhancedFatDxe / Delete.c

diff --git a/FatPkg/EnhancedFatDxe/Delete.c b/FatPkg/EnhancedFatDxe/Delete.c
index e5103a850c668424bae4f5eea97240f04bfea223..9837565a8ef8f11c8d211aeb72ff64c18d17dbb0 100644 (file)
--- a/FatPkg/EnhancedFatDxe/Delete.c
+++ b/FatPkg/EnhancedFatDxe/Delete.c
@@ -1,4 +1,5 @@
-/*++\r
+/** @file\r
+  Function that deletes a file.\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
 \r
 Copyright (c) 2005 - 2013, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available\r


@@ -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.\r
 \r
 \r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 \r

-Module Name:\r
+**/\r

 \r
 \r

-  delete.c\r
-\r
-Abstract:\r
+#include "Fat.h"\r

 \r
 \r

-  Function that deletes a file\r
+/**\r

 \r
 \r

-Revision History\r
+  Deletes the file & Closes the file handle.\r

 \r
 \r

---*/\r
+  @param  FHand                    - Handle to the file to delete.\r

 \r
 \r

-#include "Fat.h"\r
+  @retval EFI_SUCCESS              - Delete the file successfully.\r
+  @retval EFI_WARN_DELETE_FAILURE  - Fail to delete the file.\r

 \r
 \r

+**/\r

 EFI_STATUS\r
 EFIAPI\r
 FatDelete (\r
   IN EFI_FILE_PROTOCOL  *FHand\r
   )\r
 EFI_STATUS\r
 EFIAPI\r
 FatDelete (\r
   IN EFI_FILE_PROTOCOL  *FHand\r
   )\r

-/*++\r
-\r
-Routine Description:\r
-\r
-  Deletes the file & Closes the file handle.\r
-\r
-Arguments:\r
-\r
-  FHand                    - Handle to the file to delete.\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS              - Delete the file successfully.\r
-  EFI_WARN_DELETE_FAILURE  - Fail to delete the file.\r
-\r
---*/\r

 {\r
   FAT_IFILE   *IFile;\r
   FAT_OFILE   *OFile;\r
 {\r
   FAT_IFILE   *IFile;\r
   FAT_OFILE   *OFile;\r