Add comments and DoxyGen format for these files.

[mirror_edk2.git] / MdeModulePkg / Universal / FirmwareVolume / FaultTolerantWriteDxe / FtwLite.c

diff --git a/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/FtwLite.c b/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/FtwLite.c
index 81d6f6bd70b1e2983e81698700eb0ba1167f3953..25836c470a2a1877c97f235581b000e21c2e20d8 100644 (file)
--- a/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/FtwLite.c
+++ b/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/FtwLite.c
@@ -1,22 +1,6 @@
-/*++\r
-\r
-Copyright (c) 2006 - 2007, 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
-\r
-\r
-Module Name:\r
-\r
-  FtwLite.c\r
+/** @file\r
 \r
-Abstract:\r
-\r
-  This is a simple fault tolerant write driver, based on PlatformFd library.\r
+  This is a simple fault tolerant write driver.\r
   And it only supports write BufferSize <= SpareAreaLength.\r
 \r
   This boot service only protocol provides fault tolerant write capability for \r
@@ -24,13 +8,20 @@ Abstract:
   of the data and private information. It should be able to recover \r
   automatically from a critical fault, such as power failure. \r
 \r
-Notes:\r
-\r
   The implementation uses an FTW Lite (Fault Tolerant Write) Work Space. \r
   This work space is a memory copy of the work space on the Woring Block,\r
   the size of the work space is the FTW_WORK_SPACE_SIZE bytes.\r
 \r
---*/\r
+Copyright (c) 2006 - 2008, 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
+\r
+**/\r
 \r
 #include <FtwLite.h>\r
 \r