diff options
author | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-08-14 02:54:46 +0000 |
---|---|---|
committer | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-08-14 02:54:46 +0000 |
commit | 55d473ba157d12322e5946ec0e4dd5827ad6bdb0 (patch) | |
tree | edda7e94cf141dd92f78e075adb232932dd0b1b1 /MdePkg | |
parent | d484d1206719ccd807ad4bc557c452fac91de3df (diff) | |
download | edk2-platforms-55d473ba157d12322e5946ec0e4dd5827ad6bdb0.tar.xz |
Use doxygen comment style for document entity such as struct, enum, variable that use /// but not //
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5643 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg')
-rw-r--r-- | MdePkg/Include/Guid/Acpi.h | 6 | ||||
-rw-r--r-- | MdePkg/Include/Guid/AprioriFileName.h | 30 | ||||
-rw-r--r-- | MdePkg/Include/Guid/FileInfo.h | 14 | ||||
-rw-r--r-- | MdePkg/Include/Guid/FileSystemInfo.h | 14 | ||||
-rw-r--r-- | MdePkg/Include/Guid/FirmwareFileSystem2.h | 18 |
5 files changed, 37 insertions, 45 deletions
diff --git a/MdePkg/Include/Guid/Acpi.h b/MdePkg/Include/Guid/Acpi.h index 91e24f1b22..ea616d3110 100644 --- a/MdePkg/Include/Guid/Acpi.h +++ b/MdePkg/Include/Guid/Acpi.h @@ -33,9 +33,9 @@ }
#define ACPI_10_TABLE_GUID EFI_ACPI_10_TABLE_GUID
-//
-// ACPI 2.0 or newer tables should use EFI_ACPI_TABLE_GUID.
-//
+///
+/// ACPI 2.0 or newer tables should use EFI_ACPI_TABLE_GUID.
+///
#define EFI_ACPI_20_TABLE_GUID EFI_ACPI_TABLE_GUID
extern EFI_GUID gEfiAcpiTableGuid;
diff --git a/MdePkg/Include/Guid/AprioriFileName.h b/MdePkg/Include/Guid/AprioriFileName.h index c2ee1b1d55..83d0d888ec 100644 --- a/MdePkg/Include/Guid/AprioriFileName.h +++ b/MdePkg/Include/Guid/AprioriFileName.h @@ -25,27 +25,19 @@ { 0x1b45cc0a, 0x156a, 0x428a, { 0x62, 0XAF, 0x49, 0x86, 0x4d, 0xa0, 0xe6, 0xe6 } }
-/**
-
- This file must be of type EFI_FV_FILETYPE_FREEFORM and must
- contain a single section of type EFI_SECTION_RAW. For details on
- firmware volumes, firmware file types, and firmware file section
- types.
-
- @param FileNamesWithinVolume[] An array of zero or more
- EFI_GUID type entries that
- match the file names of PEIM
- modules in the same Firmware
- Volume. The maximum number of
- entries.
-
- @param NumberOfModulesInVolume Determined by the number of
- modules in the FV.
-
-**/
+
+///
+/// This file must be of type EFI_FV_FILETYPE_FREEFORM and must
+/// contain a single section of type EFI_SECTION_RAW. For details on
+/// firmware volumes, firmware file types, and firmware file section
+/// types.
+///
typedef struct {
+ ///
+ /// An array of zero or more EFI_GUID type entries that match the file names of PEIM
+ /// modules in the same Firmware Volume. The maximum number of entries.
+ ///
EFI_GUID FileNamesWithinVolume[1];
-// Optional list of file-names
} PEI_APRIORI_FILE_CONTENTS;
extern EFI_GUID gPeiAprioriFileNameGuid;
diff --git a/MdePkg/Include/Guid/FileInfo.h b/MdePkg/Include/Guid/FileInfo.h index 31c9c73951..a9f64666f3 100644 --- a/MdePkg/Include/Guid/FileInfo.h +++ b/MdePkg/Include/Guid/FileInfo.h @@ -37,13 +37,13 @@ typedef struct { CHAR16 FileName[1];
} EFI_FILE_INFO;
-//
-// The FileName field of the EFI_FILE_INFO data structure is variable length.
-// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to
-// be the size of the data structure without the FileName field. The following macro
-// computes this size correctly no matter how big the FileName array is declared.
-// This is required to make the EFI_FILE_INFO data structure ANSI compilant.
-//
+///
+/// The FileName field of the EFI_FILE_INFO data structure is variable length.
+/// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to
+/// be the size of the data structure without the FileName field. The following macro
+/// computes this size correctly no matter how big the FileName array is declared.
+/// This is required to make the EFI_FILE_INFO data structure ANSI compilant.
+///
#define SIZE_OF_EFI_FILE_INFO EFI_FIELD_OFFSET (EFI_FILE_INFO, FileName)
extern EFI_GUID gEfiFileInfoGuid;
diff --git a/MdePkg/Include/Guid/FileSystemInfo.h b/MdePkg/Include/Guid/FileSystemInfo.h index a965fb5036..6ed28b4f20 100644 --- a/MdePkg/Include/Guid/FileSystemInfo.h +++ b/MdePkg/Include/Guid/FileSystemInfo.h @@ -29,13 +29,13 @@ typedef struct { CHAR16 VolumeLabel[1];
} EFI_FILE_SYSTEM_INFO;
-//
-// The VolumeLabel field of the EFI_FILE_SYSTEM_INFO data structure is variable length.
-// Whenever code needs to know the size of the EFI_FILE_SYSTEM_INFO data structure, it needs
-// to be the size of the data structure without the VolumeLable field. The following macro
-// computes this size correctly no matter how big the VolumeLable array is declared.
-// This is required to make the EFI_FILE_SYSTEM_INFO data structure ANSI compilant.
-//
+///
+/// The VolumeLabel field of the EFI_FILE_SYSTEM_INFO data structure is variable length.
+/// Whenever code needs to know the size of the EFI_FILE_SYSTEM_INFO data structure, it needs
+/// to be the size of the data structure without the VolumeLable field. The following macro
+/// computes this size correctly no matter how big the VolumeLable array is declared.
+/// This is required to make the EFI_FILE_SYSTEM_INFO data structure ANSI compilant.
+///
#define SIZE_OF_EFI_FILE_SYSTEM_INFO EFI_FIELD_OFFSET (EFI_FILE_SYSTEM_INFO, VolumeLabel)
extern EFI_GUID gEfiFileSystemInfoGuid;
diff --git a/MdePkg/Include/Guid/FirmwareFileSystem2.h b/MdePkg/Include/Guid/FirmwareFileSystem2.h index 4a3adbb03d..383f24ff8f 100644 --- a/MdePkg/Include/Guid/FirmwareFileSystem2.h +++ b/MdePkg/Include/Guid/FirmwareFileSystem2.h @@ -18,18 +18,18 @@ #ifndef __FIRMWARE_FILE_SYSTEM2_GUID_H__
#define __FIRMWARE_FILE_SYSTEM2_GUID_H__
-//
-// The firmware volume header contains a data field for
-// the file system GUID
-//
+///
+/// The firmware volume header contains a data field for
+/// the file system GUID
+///
#define EFI_FIRMWARE_FILE_SYSTEM2_GUID \
{ 0x8c8ce578, 0x8a3d, 0x4f1c, { 0x99, 0x35, 0x89, 0x61, 0x85, 0xc3, 0x2d, 0xd3 } }
-//
-// A Volume Top File (VTF) is a file that must be
-// located such that the last byte of the file is
-// also the last byte of the firmware volume
-//
+///
+/// A Volume Top File (VTF) is a file that must be
+/// located such that the last byte of the file is
+/// also the last byte of the firmware volume
+///
#define EFI_FFS_VOLUME_TOP_FILE_GUID \
{ 0x1BA0062E, 0xC779, 0x4582, { 0x85, 0x66, 0x33, 0x6A, 0xE8, 0xF7, 0x8F, 0x9 } }
|