Add Doxygen Format File header for these C source files.
authorlgao4 <lgao4@7335b38e-4728-0410-8992-fb3ffe349368>
Tue, 15 Apr 2008 03:31:38 +0000 (03:31 +0000)
committerlgao4 <lgao4@7335b38e-4728-0410-8992-fb3ffe349368>
Tue, 15 Apr 2008 03:31:38 +0000 (03:31 +0000)
git-svn-id: https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools@1150 7335b38e-4728-0410-8992-fb3ffe349368

68 files changed:
Source/C/BootSectImage/bootsectimage.c
Source/C/BootSectImage/fat.h
Source/C/BootSectImage/mbr.h
Source/C/Common/BasePeCoff.c
Source/C/Common/BinderFuncs.c
Source/C/Common/BinderFuncs.h
Source/C/Common/CommonLib.c
Source/C/Common/CommonLib.h
Source/C/Common/Compress.h
Source/C/Common/Crc32.c
Source/C/Common/Crc32.h
Source/C/Common/Decompress.c
Source/C/Common/Decompress.h
Source/C/Common/EfiCompress.c
Source/C/Common/EfiUtilityMsgs.c
Source/C/Common/EfiUtilityMsgs.h
Source/C/Common/FirmwareVolumeBuffer.c
Source/C/Common/FirmwareVolumeBufferLib.h
Source/C/Common/FvLib.c
Source/C/Common/FvLib.h
Source/C/Common/MemoryFile.c
Source/C/Common/MemoryFile.h
Source/C/Common/MyAlloc.c
Source/C/Common/MyAlloc.h
Source/C/Common/OsPath.c
Source/C/Common/OsPath.h
Source/C/Common/ParseGuidedSectionTools.c
Source/C/Common/ParseGuidedSectionTools.h
Source/C/Common/ParseInf.c
Source/C/Common/ParseInf.h
Source/C/Common/PeCoffLib.h
Source/C/Common/PeCoffLoaderEx.c
Source/C/Common/SimpleFileParsing.c
Source/C/Common/SimpleFileParsing.h
Source/C/Common/StringFuncs.c
Source/C/Common/StringFuncs.h
Source/C/Common/TianoCompress.c
Source/C/Common/WinNtInclude.h
Source/C/EfiLdrImage/EfiLdrImage.c
Source/C/EfiRom/EfiRom.c
Source/C/EfiRom/EfiRom.h
Source/C/GenBootSector/FatFormat.h
Source/C/GenBootSector/GenBootSector.c
Source/C/GenBootSector/GetDrvNumOffset.c
Source/C/GenCrc32/GenCrc32.c
Source/C/GenFfs/GenFfs.c
Source/C/GenFv/GenFv.c
Source/C/GenFv/GenFvInternalLib.c
Source/C/GenFv/GenFvInternalLib.h
Source/C/GenFw/GenFw.c
Source/C/GenPage/GenPage.c
Source/C/GenPage/VirtualMemory.h
Source/C/GenSec/GenSec.c
Source/C/GenVtf/GenVtf.c
Source/C/GenVtf/GenVtf.h
Source/C/Split/Split.c
Source/C/TianoCompress/TianoCompress.c
Source/C/VfrCompile/EfiVfr.h
Source/C/VfrCompile/VfrCompiler.cpp
Source/C/VfrCompile/VfrCompiler.h
Source/C/VfrCompile/VfrError.cpp
Source/C/VfrCompile/VfrError.h
Source/C/VfrCompile/VfrFormPkg.cpp
Source/C/VfrCompile/VfrFormPkg.h
Source/C/VfrCompile/VfrUtilityLib.cpp
Source/C/VfrCompile/VfrUtilityLib.h
Source/C/VolInfo/VolInfo.c
Source/C/VolInfo/VolInfo.h

index 98c7296..059a2e4 100644 (file)
@@ -1,6 +1,10 @@
-/*++\r
+/** @file\r
+\r
+Abstract:\r
+  Patch the BPB information in boot sector image file.\r
+  Patch the MBR code in MBR image file.\r
 \r
-Copyright 2006 - 2007, Intel Corporation                                                         \r
+Copyright 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
@@ -9,15 +13,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-  bootsectimage.c\r
-    \r
-Abstract:\r
-  Patch the BPB information in boot sector image file.\r
-  Patch the MBR code in MBR image file.\r
-\r
---*/\r
+**/\r
 \r
 #include <stdio.h>\r
 #include "fat.h"\r
index bca9105..fac03e6 100644 (file)
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
 \r
-Copyright 2006, Intel Corporation                                                         \r
+  Fat file system structure and definition.\r
+\r
+Copyright 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
@@ -9,15 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-    fat.h\r
-    \r
-Abstract:\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _FAT_BPB_H_\r
 #define _FAT_BPB_H_\r
index ac8c6f1..9103585 100644 (file)
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
 \r
-Copyright 2006, Intel Corporation                                                         \r
+  MBR Partition Entry and Table structure defintions.\r
+\r
+Copyright 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
@@ -9,15 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-    mbr.h\r
-    \r
-Abstract:\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _MBR_H_\r
 #define _MBR_H_\r
index ce906b7..1d59708 100644 (file)
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
+\r
+  Functions to get info and load PE/COFF image.\r
 \r
-Copyright (c) 2004 - 2005, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -9,17 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-  PeCoffLoader.c\r
-\r
-Abstract:\r
-\r
-  Tiano PE/COFF loader \r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
 \r
 #include <Common/UefiBaseTypes.h>\r
 #include <IndustryStandard/PeImage.h>\r
index c369f2e..7975878 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 1999 - 2007, Intel Corporation\r
+Copyright (c) 1999 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Binder function implementations for ANSI C libraries.\r
 \r
---*/\r
+**/\r
 \r
 #include "BinderFuncs.h"\r
 \r
index 9d00ad4..779c5a2 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 1999 - 2007, Intel Corporation\r
+Copyright (c) 1999 - 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
@@ -20,7 +20,7 @@ Abstract:
   which is appropriate for the specific environment that they\r
   are running under.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef BinderFuncs_h_INCLUDED\r
 #define BinderFuncs_h_INCLUDED\r
index 6d87b33..17bc2fa 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -15,9 +15,9 @@ Module Name:
 \r
 Abstract:\r
 \r
-  Common Library Functions\r
+  Common basic Library Functions\r
  \r
---*/\r
+**/\r
 \r
 #include <stdio.h>\r
 #include <string.h>\r
index 9f43ce8..769ac1b 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Common library assistance routines.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_COMMON_LIB_H\r
 #define _EFI_COMMON_LIB_H\r
@@ -98,7 +98,7 @@ Returns:
   EFI_ABORTED              An error occurred.\r
   EFI_OUT_OF_RESOURCES     No resource to complete operations.\r
 \r
---*/\r
+**/\r
 \r
 UINT8\r
 CalculateChecksum8 (\r
index a50134e..10d0c72 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004 - 2006, Intel Corporation                                              \r
+Copyright (c) 2004 - 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
@@ -18,7 +18,7 @@ Abstract:
   Header file for compression routine.\r
   Providing both EFI and Tiano Compress algorithms.\r
   \r
---*/\r
+**/\r
 \r
 #ifndef _COMPRESS_H_\r
 #define _COMPRESS_H_\r
index 4ae5eb4..f52b514 100644 (file)
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2004, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -17,7 +17,7 @@ Abstract:
 \r
   CalcuateCrc32 routine.\r
   \r
---*/\r
+**/\r
 \r
 #include <stdlib.h>\r
 #include "Crc32.h"\r
index ec48cdd..e598a91 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Header file for CalcuateCrc32 routine\r
   \r
---*/\r
+**/\r
 \r
 #ifndef _CRC32_H\r
 #define _CRC32_H\r
index 07b2b8c..a76dd25 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
index 5984e0b..fa7b202 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2006, Intel Corporation                                                         \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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Header file for compression routine\r
   \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_DECOMPRESS_H\r
 #define _EFI_DECOMPRESS_H\r
@@ -31,7 +31,7 @@ EfiGetInfo (
   OUT     UINT32  *DstSize,\r
   OUT     UINT32  *ScratchSize\r
   );\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -49,7 +49,7 @@ Returns:
   EFI_SUCCESS           - The size of destination buffer and the size of scratch buffer are successull retrieved.\r
   EFI_INVALID_PARAMETER - The source data is corrupted\r
 \r
---*/\r
+**/\r
 \r
 EFI_STATUS\r
 EfiDecompress (\r
@@ -60,7 +60,7 @@ EfiDecompress (
   IN OUT  VOID    *Scratch,\r
   IN      UINT32  ScratchSize\r
   );\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -80,7 +80,7 @@ Returns:
   EFI_SUCCESS           - Decompression is successfull\r
   EFI_INVALID_PARAMETER - The source data is corrupted\r
 \r
---*/\r
+**/\r
 \r
 EFI_STATUS\r
 TianoGetInfo (\r
@@ -89,7 +89,7 @@ TianoGetInfo (
   OUT     UINT32  *DstSize,\r
   OUT     UINT32  *ScratchSize\r
   );\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -107,7 +107,7 @@ Returns:
   EFI_SUCCESS           - The size of destination buffer and the size of scratch buffer are successull retrieved.\r
   EFI_INVALID_PARAMETER - The source data is corrupted\r
 \r
---*/\r
+**/\r
 \r
 EFI_STATUS\r
 TianoDecompress (\r
@@ -118,7 +118,7 @@ TianoDecompress (
   IN OUT  VOID    *Scratch,\r
   IN      UINT32  ScratchSize\r
   );\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -138,7 +138,7 @@ Returns:
   EFI_SUCCESS           - Decompression is successfull\r
   EFI_INVALID_PARAMETER - The source data is corrupted\r
 \r
---*/\r
+**/\r
 \r
 typedef\r
 EFI_STATUS\r
index 87f52fd..47926d8 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2006, Intel Corporation                                              \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
@@ -21,7 +21,7 @@ Abstract:
   This sequence is further divided into Blocks and Huffman codings\r
   are applied to each Block.\r
 \r
---*/\r
+**/\r
 \r
 #include "Compress.h"\r
 \r
index eb6d27b..36f2cf1 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
index 0df1c48..6c2f9d2 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Defines and prototypes for common EFI utility error and debug messages.\r
   \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_UTILITY_MSGS_H_\r
 #define _EFI_UTILITY_MSGS_H_\r
index 9cfea00..224ade3 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 1999 - 2007, Intel Corporation\r
+Copyright (c) 1999 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   EFI Firmware Volume routines which work on a Fv image in buffers.\r
 \r
---*/\r
+**/\r
 \r
 #include "FirmwareVolumeBufferLib.h"\r
 #include "BinderFuncs.h"\r
index d51af93..5a52695 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 1999 - 2007, Intel Corporation\r
+Copyright (c) 1999 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   EFI Firmware Volume routines which work on a Fv image in buffers.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef FirmwareVolumeBuffer_h_INCLUDED\r
 #define FirmwareVolumeBuffer_h_INCLUDED\r
index cdecfd9..f9d783a 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004 - 2006, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   These functions assist in parsing and manipulating a Firmware Volume.\r
 \r
---*/\r
+**/\r
 \r
 //\r
 // Include files\r
index eda9bf8..43d3737 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   These functions assist in parsing and manipulating a Firmware Volume.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_FV_LIB_H\r
 #define _EFI_FV_LIB_H\r
index ce7d9f7..42f7ed4 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   This contains some useful functions for accessing files.\r
 \r
---*/\r
+**/\r
 \r
 #include <assert.h>\r
 #include <string.h>\r
index aeb804a..9148d9d 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Header file for helper functions useful for accessing files.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_MEMORY_FILE_H\r
 #define _EFI_MEMORY_FILE_H\r
@@ -50,7 +50,7 @@ GetMemoryFile (
   OUT EFI_HANDLE *OutputMemoryFile\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -67,7 +67,7 @@ Returns:
   EFI_STATUS\r
   OutputMemoryFile is valid if !EFI_ERROR\r
 \r
---*/\r
+**/\r
 \r
 \r
 EFI_STATUS\r
@@ -75,7 +75,7 @@ FreeMemoryFile (
   IN EFI_HANDLE InputMemoryFile\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -89,7 +89,7 @@ Returns:
 \r
   EFI_STATUS\r
 \r
---*/\r
+**/\r
 \r
 \r
 CHAR8 *\r
@@ -97,7 +97,7 @@ ReadMemoryFileLine (
   IN EFI_HANDLE     InputMemoryFile\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -116,7 +116,7 @@ Returns:
   NULL if error or EOF\r
   NULL character termincated string otherwise (MUST BE FREED BY CALLER)\r
 \r
---*/\r
+**/\r
 \r
 \r
 #endif\r
index 367226d..b7fdbf5 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   File for memory allocation tracking functions.\r
 \r
---*/\r
+**/\r
 \r
 #include "MyAlloc.h"\r
 \r
index 9697012..9dbe91c 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Header file for memory allocation tracking functions.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _MYALLOC_H_\r
 #define _MYALLOC_H_\r
index 0e3f105..03ec55c 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2007, Intel Corporation                                                         \r
+Copyright (c) 2007 - 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
@@ -15,9 +15,9 @@ Module Name:
 \r
 Abstract:\r
 \r
-  Header file for helper functions useful for accessing files.\r
+  Functions useful to operate file directories by parsing file path.\r
 \r
---*/\r
+**/\r
 \r
 #include <stdio.h>\r
 #include "OsPath.h"\r
index 894c57c..0386dfa 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2007, Intel Corporation                                                         \r
+Copyright (c) 2007 - 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
@@ -15,9 +15,10 @@ Module Name:
 \r
 Abstract:\r
 \r
-  Header file for helper functions useful for parsing INF files.\r
+  Header file for helper functions useful to operate file directories \r
+  by parsing file path. \r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_OS_PATH_H\r
 #define _EFI_OS_PATH_H\r
@@ -33,7 +34,7 @@ OsPathDirName (
   IN CHAR8    *FilePath\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -57,7 +58,7 @@ Returns:
 \r
   NULL if error\r
 \r
---*/\r
+**/\r
 \r
 \r
 VOID\r
@@ -65,7 +66,7 @@ OsPathNormPathInPlace (
   IN CHAR8    *Path\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -85,7 +86,7 @@ Returns:
 \r
   The string is altered in place.\r
 \r
---*/\r
+**/\r
 \r
 \r
 CHAR8*\r
@@ -94,7 +95,7 @@ OsPathPeerFilePath (
   IN CHAR8    *Peer\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -116,7 +117,7 @@ Returns:
 \r
   A CHAR8* string, which must be freed by the caller\r
 \r
---*/\r
+**/\r
 \r
 \r
 BOOLEAN\r
@@ -124,7 +125,7 @@ OsPathExists (
   IN CHAR8    *InputFileName\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -139,7 +140,7 @@ Returns:
   TRUE              The file exists\r
   FALSE             The file does not exist\r
 \r
---*/\r
+**/\r
 \r
 \r
 #endif\r
index 5432853..e831f4c 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2007, Intel Corporation                                                         \r
+Copyright (c) 2007 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Helper functions for parsing GuidedSectionTools.txt\r
 \r
---*/\r
+**/\r
 \r
 #include <assert.h>\r
 #include <string.h>\r
index 5a3d868..d30afff 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2007, Intel Corporation                                                         \r
+Copyright (c) 2007 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Header file for helper functions for parsing GuidedSectionTools.txt\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_PARSE_GUIDED_SECTION_TOOLS_H\r
 #define _EFI_PARSE_GUIDED_SECTION_TOOLS_H\r
@@ -33,7 +33,7 @@ ParseGuidedSectionToolsFile (
   IN CHAR8    *InputFile\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -52,7 +52,7 @@ Returns:
   NULL if error parsing\r
   A non-NULL EFI_HANDLE otherwise\r
 \r
---*/\r
+**/\r
 \r
 \r
 EFI_HANDLE\r
@@ -60,7 +60,7 @@ ParseGuidedSectionToolsMemoryFile (
   IN EFI_HANDLE    InputFile\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -79,7 +79,7 @@ Returns:
   NULL if error parsing\r
   A non-NULL EFI_HANDLE otherwise\r
 \r
---*/\r
+**/\r
 \r
 CHAR8*\r
 LookupGuidedSectionToolPath (\r
@@ -87,7 +87,7 @@ LookupGuidedSectionToolPath (
   IN EFI_GUID   *SectionGuid\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -105,14 +105,14 @@ Returns:
   Non-NULL - The tool to use to access the section contents.  (The caller\r
              must free the memory associated with this string.)\r
 \r
---*/\r
+**/\r
 \r
 EFI_STATUS\r
 FreeParsedGuidedSectionToolsHandle (\r
   IN EFI_HANDLE ParsedGuidedSectionToolsHandle\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -128,6 +128,6 @@ Returns:
 \r
   EFI_STATUS\r
 \r
---*/\r
+**/\r
 \r
 #endif\r
index ddc388b..f2f8abc 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
index c0d49b4..af532b8 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Header file for helper functions useful for parsing INF files.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_PARSE_INF_H\r
 #define _EFI_PARSE_INF_H\r
index 08e8195..9eb7573 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-       Memory Only PE COFF loader\r
+       Function prototypes and defines on Memory Only PE COFF loader\r
 \r
        Copyright (c) 2006, Intel Corporation                                                         \r
        All rights reserved. This program and the accompanying materials                          \r
index b2a4370..fedc094 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
index 0bf0be3..39bf50f 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
index 71b698a..7b33727 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Function prototypes and defines for the simple file parsing routines.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _SIMPLE_FILE_PARSING_H_\r
 #define _SIMPLE_FILE_PARSING_H_\r
index 5ec2aff..17901fe 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2007, Intel Corporation                                                         \r
+Copyright (c) 2007 - 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
@@ -15,9 +15,9 @@ Module Name:
 \r
 Abstract:\r
 \r
-  Header file for helper functions useful for accessing files.\r
+  Function prototypes and defines for string routines.\r
 \r
---*/\r
+**/\r
 \r
 #include "StringFuncs.h"\r
 \r
@@ -99,7 +99,7 @@ Returns:
   // What about multiline comments?\r
   //\r
 \r
-  Pos = strstr (String, "//");\r
+  Pos = strstr (String,  "//");\r
   if (Pos != NULL) {\r
     *Pos = '\0';\r
   }\r
index 219cfc9..cf18460 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/**\r
 \r
-Copyright (c) 2007, Intel Corporation                                                         \r
+Copyright (c) 2007 - 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
@@ -15,9 +15,9 @@ Module Name:
 \r
 Abstract:\r
 \r
-  Header file for helper functions useful for accessing files.\r
+  String routines implementation.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_STRING_FUNCS_H\r
 #define _EFI_STRING_FUNCS_H\r
@@ -47,7 +47,7 @@ CloneString (
   IN CHAR8       *String\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -61,7 +61,7 @@ Returns:
 \r
   CHAR8* - NULL if there are not enough resources\r
 \r
---*/\r
+**/\r
 \r
 \r
 EFI_STATUS\r
@@ -69,7 +69,7 @@ StripInfDscStringInPlace (
   IN CHAR8       *String\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -83,7 +83,7 @@ Returns:
 \r
   EFI_STATUS\r
 \r
---*/\r
+**/\r
 \r
 \r
 STRING_LIST*\r
@@ -91,7 +91,7 @@ SplitStringByWhitespace (
   IN CHAR8       *String\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -106,14 +106,14 @@ Returns:
 \r
   EFI_STATUS\r
 \r
---*/\r
+**/\r
 \r
 \r
 STRING_LIST*\r
 NewStringList (\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -123,7 +123,7 @@ Returns:
 \r
   STRING_LIST* - Null if there is not enough resources to create the object.\r
 \r
---*/\r
+**/\r
 \r
 \r
 EFI_STATUS\r
@@ -132,7 +132,7 @@ AppendCopyOfStringToList (
   IN CHAR8       *String\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -143,7 +143,7 @@ Returns:
 \r
   EFI_STATUS\r
 \r
---*/\r
+**/\r
 \r
 \r
 EFI_STATUS\r
@@ -151,7 +151,7 @@ RemoveLastStringFromList (
   IN STRING_LIST       *StringList\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -166,7 +166,7 @@ Returns:
 \r
   EFI_STATUS\r
 \r
---*/\r
+**/\r
 \r
 \r
 STRING_LIST*\r
@@ -174,7 +174,7 @@ AllocateStringListStruct (
   IN UINTN StringCount\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -188,7 +188,7 @@ Returns:
 \r
   EFI_STATUS\r
 \r
---*/\r
+**/\r
 \r
 \r
 VOID\r
@@ -196,7 +196,7 @@ FreeStringList (
   IN STRING_LIST       *StringList\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -210,7 +210,7 @@ Returns:
 \r
   EFI_STATUS\r
 \r
---*/\r
+**/\r
 \r
 \r
 CHAR8*\r
@@ -218,7 +218,7 @@ StringListToString (
   IN STRING_LIST       *StringList\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -233,7 +233,7 @@ Returns:
   CHAR8* - The string list represented with a single string.  The returned\r
            string must be freed by the caller.\r
 \r
---*/\r
+**/\r
 \r
 \r
 VOID\r
@@ -241,7 +241,7 @@ PrintStringList (
   IN STRING_LIST       *StringList\r
   )\r
 ;\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -251,7 +251,7 @@ Arguments:
 \r
   StringList        The string list to print\r
 \r
---*/\r
+**/\r
 \r
 \r
 #endif\r
index 4e62b07..2936aa9 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2006, Intel Corporation                                              \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
@@ -21,7 +21,7 @@ Abstract:
   This sequence is further divided into Blocks and Huffman codings\r
   are applied to each Block.\r
 \r
---*/\r
+**/\r
 \r
 #include "Compress.h"\r
 \r
index 80e45b4..574a7d8 100644 (file)
@@ -1,6 +1,6 @@
-/*--\r
+/** @file\r
 \r
-Copyright (c) 2006, Intel Corporation\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
@@ -15,7 +15,7 @@ Module Name:
 Abstract:\r
   Include file for the WinNt Library\r
 \r
---*/\r
+**/\r
 \r
 #ifndef __WIN_NT_INCLUDE_H__\r
 #define __WIN_NT_INCLUDE_H__\r
index 1c931d2..3952c45 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright 2006 - 2007, Intel Corporation                                                         \r
+Copyright 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
@@ -24,7 +24,7 @@ Abstract:
 \r
 Revision History\r
 \r
---*/\r
+**/\r
 \r
 \r
 #include <stdio.h>\r
index 8fd1567..0ea299b 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c)  1999-2007 Intel Corporation. All rights reserved\r
+Copyright (c)  1999-2008 Intel Corporation. All rights reserved\r
 This program and the accompanying materials are licensed and made available \r
 under the terms and conditions of the BSD License which accompanies this \r
 distribution.  The full text of the license may be found at\r
@@ -18,8 +18,7 @@ Abstract:
   Utility program to create an EFI option ROM image from binary and \r
   EFI PE32 files.\r
 \r
-\r
---*/\r
+**/\r
 \r
 #include "EfiRom.h"\r
 \r
index cdcf357..41e65a5 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 1999 - 2007 Intel Corporation. All rights reserved\r
+Copyright (c) 1999 - 2008 Intel Corporation. All rights reserved\r
 This software and associated documentation (if any) is furnished\r
 under a license and may only be used or copied in accordance\r
 with the terms of the license. Except as permitted by such\r
@@ -19,7 +19,7 @@ Abstract:
   This file contains the relevant declarations required\r
   to generate Option Rom File\r
 \r
---*/\r
+**/\r
 \r
 #ifndef __EFI_ROM_H__\r
 #define __EFI_ROM_H__\r
index bca9105..f24b4ee 100644 (file)
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
 \r
-Copyright 2006, Intel Corporation                                                         \r
+  Fat file system structure and definition.\r
+\r
+Copyright 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
@@ -9,14 +11,6 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-    fat.h\r
-    \r
-Abstract:\r
-\r
-Revision History\r
-\r
 --*/\r
 \r
 #ifndef _FAT_BPB_H_\r
index f783da9..4a589b3 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright 2006 - 2007, Intel Corporation                                                         \r
+Copyright 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
@@ -19,7 +19,7 @@ Abstract:
     If we write MBR to disk, we just update the MBR code and the partition table wouldn't be over written.\r
     If we process DBR, we will patch MBR to set first partition active if no active partition exists.\r
 \r
---*/\r
+**/\r
 \r
 #include <windows.h>\r
 #include <stdio.h>\r
index 4472234..a55137b 100644 (file)
@@ -1,3 +1,18 @@
+/** @file\r
+\r
+  Get Drv Num offset from Fat file system.\r
+\r
+Copyright 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 <stdio.h>\r
 #include "FatFormat.h"\r
 \r
index 9f2ee22..083515f 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2007, Intel Corporation                                              \r
+Copyright (c) 2007 - 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
@@ -16,7 +16,7 @@ Module Name:
 Abstract:\r
   Calculate Crc32 value and Verify Crc32 value for input data.\r
 \r
---*/\r
+**/\r
 \r
 #include <stdio.h>\r
 #include <stdlib.h>\r
index e6b834c..87d64aa 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/**\r
 \r
-Copyright (c) 2004-2007, Intel Corporation                                                         \r
+Copyright (c) 2004-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
@@ -18,7 +18,7 @@ Abstract:
   This file contains functions required to generate a Firmware File System\r
   file.\r
 \r
---*/\r
+**/\r
 \r
 #include <stdio.h>\r
 #include <stdlib.h>\r
index f822f99..7288995 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2007, Intel Corporation                                                         \r
+Copyright (c) 2007 - 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
@@ -20,7 +20,7 @@ Abstract:
   can be found in the Tiano Firmware Volume Generation Utility \r
   Specification, review draft.\r
 \r
---*/\r
+**/\r
 \r
 //\r
 // File included in build\r
index 420542a..7a84183 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -15,9 +15,9 @@ Module Name:
 \r
 Abstract:\r
 \r
-  This file contains functions required to generate a Firmware Volume.\r
+  This file contains the internal functions required to generate a Firmware Volume.\r
 \r
---*/\r
+**/\r
 \r
 //\r
 // Include files\r
index 3cbf1b3..767cae9 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -18,7 +18,7 @@ Abstract:
   This file contains describes the public interfaces to the GenFvImage Library.\r
   The basic purpose of the library is to create Firmware Volume images.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_GEN_FV_INTERNAL_LIB_H\r
 #define _EFI_GEN_FV_INTERNAL_LIB_H\r
index 463bad7..eb4b6eb 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -15,9 +15,9 @@ Module Name:
 \r
 Abstract:\r
 \r
-    Converts a pe32+ image to an FW image type\r
+    Converts a pe32+ image to an FW, Te image type, or other specific image. \r
 \r
---*/\r
+**/\r
 \r
 #include "WinNtInclude.h"\r
 \r
index 1876444..e997b9c 100644 (file)
@@ -1,6 +1,6 @@
-/*++ \r
+/** @file\r
 \r
-Copyright 2006 - 2007, Intel Corporation                                                         \r
+Copyright 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
@@ -28,7 +28,7 @@ Abstract:
                         (\r
                           Directory-Ptr Directory {512}\r
                         ) {4}\r
---*/\r
+**/\r
 \r
 #include <stdio.h>\r
 #include <stdlib.h>\r
index d14ea86..b4baec8 100644 (file)
@@ -1,6 +1,6 @@
-/*++ \r
+/** @file \r
 \r
-Copyright 2006 - 2007, Intel Corporation                                                         \r
+Copyright 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
@@ -21,7 +21,7 @@ Abstract:
     2) IA-32 Intel(R) Atchitecture Software Developer's Manual Volume 2:Instruction Set Reference, Intel\r
     3) IA-32 Intel(R) Atchitecture Software Developer's Manual Volume 3:System Programmer's Guide, Intel\r
     4) AMD64 Architecture Programmer's Manual Volume 2: System Programming\r
---*/\r
+**/\r
 \r
 #ifndef _VIRTUAL_MEMORY_H_\r
 #define _VIRTUAL_MEMORY_H_\r
index eb13500..0196f3a 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -15,9 +15,9 @@ Module Name:
 \r
 Abstract:\r
 \r
-  Creates output file that is a properly formed section per the FV spec.\r
+  Creates output file that is a properly formed section per the PI spec.\r
 \r
---*/\r
+**/\r
 \r
 #include <stdio.h>\r
 #include <stdlib.h>\r
index d069660..d6dabe6 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/**\r
 \r
-Copyright (c)  1999 - 2007, Intel Corporation. All rights reserved\r
+Copyright (c)  1999 - 2008, Intel Corporation. All rights reserved\r
 This software and associated documentation (if any) is furnished\r
 under a license and may only be used or copied in accordance\r
 with the terms of the license. Except as permitted by such\r
@@ -19,7 +19,7 @@ Abstract:
   This file contains functions required to generate a boot strap file (BSF) \r
   also known as the Volume Top File (VTF)\r
 \r
---*/\r
+**/\r
 \r
 //\r
 //\r
index 2c62b6e..25ce114 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 1999 - 2007 Intel Corporation. All rights reserved\r
+Copyright (c) 1999 - 2008 Intel Corporation. All rights reserved\r
 This software and associated documentation (if any) is furnished\r
 under a license and may only be used or copied in accordance\r
 with the terms of the license. Except as permitted by such\r
@@ -19,7 +19,7 @@ Abstract:
   This file contains the relevant declarations required\r
   to generate Boot Strap File\r
 \r
---*/\r
+**/\r
 \r
 //\r
 // Module Coded to EFI 2.0 Coding Conventions\r
index 12265a0..e05f3e5 100644 (file)
@@ -1,6 +1,8 @@
-/*\r
+/** @file\r
 \r
-Copyright (c)  1999-2007 Intel Corporation. All rights reserved\r
+  Split a file into two pieces at the request offset.\r
+\r
+Copyright (c)  1999-2008 Intel Corporation. All rights reserved\r
 This program and the accompanying materials are licensed and made available \r
 under the terms and conditions of the BSD License which accompanies this \r
 distribution.  The full text of the license may be found at\r
@@ -9,7 +11,7 @@ http://opensource.org/licenses/bsd-license.php
 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
 \r
 // GC_TODO: fix comment to start with /*++\r
 #include <stdio.h>\r
index ecd77cb..a3ad0c6 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2007, Intel Corporation                                              \r
+Copyright (c) 2007 - 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
@@ -21,7 +21,7 @@ Abstract:
   This sequence is further divided into Blocks and Huffman codings\r
   are applied to each Block.\r
 \r
---*/\r
+**/\r
 \r
 #include "Compress.h"\r
 #include "TianoCompress.h"\r
index c140c97..a88b101 100644 (file)
@@ -1,6 +1,6 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation                                                         \r
+Copyright (c) 2004 - 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
@@ -17,7 +17,7 @@ Abstract:
 \r
   Defines and prototypes for the UEFI VFR compiler internal use.\r
   \r
---*/\r
+**/\r
 \r
 #ifndef _EFIVFR_H_\r
 #define _EFIVFR_H_\r
index 197c81b..2620576 100644 (file)
@@ -1,3 +1,18 @@
+/** @file\r
+  \r
+  VfrCompiler main class and main function.\r
+\r
+Copyright (c) 2004 - 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 "stdio.h"\r
 #include "stdlib.h"\r
 #include "string.h"\r
index 7142c49..081ed4d 100644 (file)
@@ -1,3 +1,18 @@
+/** @file\r
+  \r
+  VfrCompiler internal defintions.\r
+\r
+Copyright (c) 2004 - 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
 #ifndef _VFRCOMPILER_H_\r
 #define _VFRCOMPILER_H_\r
 \r
index f3a296d..119ded0 100644 (file)
@@ -1,3 +1,18 @@
+/** @file\r
+  \r
+  VfrCompiler error handler.\r
+\r
+Copyright (c) 2004 - 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 "stdio.h"\r
 #include "string.h"\r
 #include "stdlib.h"\r
index 73234f4..971dc3b 100644 (file)
@@ -1,3 +1,18 @@
+/** @file\r
+  \r
+  VfrCompiler Error definition\r
+\r
+Copyright (c) 2004 - 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
 #ifndef _VFRERROR_H_\r
 #define _VFRERROR_H_\r
 \r
index 1154893..04dc8c7 100644 (file)
@@ -1,3 +1,18 @@
+/** @file\r
+  \r
+  The definition of CFormPkg's member function\r
+\r
+Copyright (c) 2004 - 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 "stdio.h"\r
 #include "VfrFormPkg.h"\r
 \r
index 8dc5476..69540a4 100644 (file)
@@ -1,3 +1,18 @@
+/** @file\r
+  \r
+  The definition of CFormPkg's member function\r
+\r
+Copyright (c) 2004 - 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
 #ifndef _EFIIFRCLASS_H_\r
 #define _EFIIFRCLASS_H_\r
 \r
index a33376d..a07927d 100644 (file)
@@ -1,3 +1,18 @@
+/** @file\r
+  \r
+  Vfr common library functions.\r
+\r
+Copyright (c) 2004 - 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 "stdio.h"\r
 #include "stdlib.h"\r
 #include "VfrUtilityLib.h"\r
index 72c4cb7..0f6d133 100644 (file)
@@ -1,3 +1,18 @@
+/** @file\r
+  \r
+  Vfr common library functions.\r
+\r
+Copyright (c) 2004 - 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
 #ifndef _VFRUTILITYLIB_H_\r
 #define _VFRUTILITYLIB_H_\r
 \r
index fb655c5..f2d2dd2 100644 (file)
@@ -1,6 +1,6 @@
-/*++
+/** @file
 
-Copyright (c) 1999 - 2007, Intel Corporation
+Copyright (c) 1999 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
 which accompanies this distribution.  The full text of the license may be found at
@@ -17,7 +17,7 @@ Abstract:
 
   The tool dumps the contents of a firmware volume
 
---*/
+**/
 
 #include <stdio.h>
 #include <stdlib.h>
index b212766..2bee33a 100644 (file)
@@ -1,6 +1,6 @@
-/*++
+/** @file
 
-Copyright (c) 1999 - 2007, Intel Corporation
+Copyright (c) 1999 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
 which accompanies this distribution.  The full text of the license may be found at
@@ -17,7 +17,7 @@ Abstract:
 
   Local Definitions for the VolInfo utility
 
---*/
+**/
 
 #ifndef _VOLINFO_H_
 #define _VOLINFO_H_ 1