Clean up DEC files:

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / FwVol / FwVolWrite.c

diff --git a/MdeModulePkg/Core/Dxe/FwVol/FwVolWrite.c b/MdeModulePkg/Core/Dxe/FwVol/FwVolWrite.c
index 4368fe534ed4464b4bbb1e873f1cdfec2be58e63..1ec563c8655e9a885c7b385ad4e372883c2cc532 100644 (file)
--- a/MdeModulePkg/Core/Dxe/FwVol/FwVolWrite.c
+++ b/MdeModulePkg/Core/Dxe/FwVol/FwVolWrite.c
@@ -1,60 +1,52 @@
-/*++\r
+/** @file\r
+  Implements functions to write firmware file\r
 \r
-Copyright (c) 2006, Intel Corporation                                                         \r
-All rights reserved. This program and the accompanying materials                          \r
-are licensed and made available under the terms and conditions of the BSD License         \r
-which accompanies this distribution.  The full text of the license may be found at        \r
-http://opensource.org/licenses/bsd-license.php                                            \r
-                                                                                          \r
-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
+Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution.  The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
 \r
-Module Name:\r
+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
-  FwVolWrite.c\r
+**/\r
 \r
-Abstract:\r
+#include "DxeMain.h"\r
+#include "FwVolDriver.h"\r
 \r
-  Implements write firmware file\r
 \r
---*/\r
+/**\r
+  Writes one or more files to the firmware volume.\r
 \r
-#include <DxeMain.h>\r
+  @param  This                   Indicates the calling context.\r
+  @param  NumberOfFiles          Number of files.\r
+  @param  WritePolicy            WritePolicy indicates the level of reliability\r
+                                 for the write in the event of a power failure or\r
+                                 other system failure during the write operation.\r
+  @param  FileData               FileData is an pointer to an array of\r
+                                 EFI_FV_WRITE_DATA. Each element of array\r
+                                 FileData represents a file to be written.\r
 \r
+  @retval EFI_SUCCESS            Files successfully written to firmware volume\r
+  @retval EFI_OUT_OF_RESOURCES   Not enough buffer to be allocated.\r
+  @retval EFI_DEVICE_ERROR       Device error.\r
+  @retval EFI_WRITE_PROTECTED    Write protected.\r
+  @retval EFI_NOT_FOUND          Not found.\r
+  @retval EFI_INVALID_PARAMETER  Invalid parameter.\r
+  @retval EFI_UNSUPPORTED        This function not supported.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 FvWriteFile (\r
-  IN EFI_FIRMWARE_VOLUME_PROTOCOL   *This,\r
-  IN UINT32                         NumberOfFiles,\r
-  IN EFI_FV_WRITE_POLICY            WritePolicy,\r
-  IN EFI_FV_WRITE_FILE_DATA         *FileData\r
+  IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL  *This,\r
+  IN       UINT32                         NumberOfFiles,\r
+  IN       EFI_FV_WRITE_POLICY            WritePolicy,\r
+  IN       EFI_FV_WRITE_FILE_DATA         *FileData\r
   )\r
-/*++\r
-\r
-    Routine Description:\r
-      Writes one or more files to the firmware volume.\r
-\r
-    Arguments:\r
-    This            - Indicates the calling context.\r
-    NumberOfFiles   - Number of files.\r
-    WritePolicy     - WritePolicy indicates the level of reliability for\r
-                      the write in the event of a power failure or other\r
-                      system failure during the write operation.\r
-    FileData        - FileData is an pointer to an array of EFI_FV_WRITE_DATA.\r
-                      Each element of FileData[] represents a file to be written.\r
-\r
-    Returns:\r
-      EFI_SUCCESS                   - Files successfully written to firmware volume\r
-      EFI_OUT_OF_RESOURCES          - Not enough buffer to be allocated.\r
-      EFI_DEVICE_ERROR              - Device error.\r
-      EFI_WRITE_PROTECTED           - Write protected.\r
-      EFI_NOT_FOUND                 - Not found.\r
-      EFI_INVALID_PARAMETER         - Invalid parameter.\r
-      EFI_UNSUPPORTED               - This function not supported.\r
-\r
---*/\r
-{ \r
+{\r
   return EFI_UNSUPPORTED;\r
 }\r
 \r
+\r