diff options
author | yshang1 <yshang1@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-03 04:56:34 +0000 |
---|---|---|
committer | yshang1 <yshang1@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-03 04:56:34 +0000 |
commit | c311f86b23f334412fa0b57ede8b4daec7ec66fe (patch) | |
tree | c938d23357d9da5508c13d0be8b14007297b9676 /MdePkg/Include/Ppi | |
parent | a69a84d3cb5e3824b973321addc2336589848305 (diff) | |
download | edk2-platforms-c311f86b23f334412fa0b57ede8b4daec7ec66fe.tar.xz |
[Description]
Scrub MdePkg:
- Add file description with doxygen format.
- Add calling convention of library class in MdePkg.
- Add function descriptions of public protocol/library class.
[Impaction]
It should be backward-compatible.
[Ref Info]
N/A
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@4985 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Ppi')
-rw-r--r-- | MdePkg/Include/Ppi/Decompress.h | 2 | ||||
-rw-r--r-- | MdePkg/Include/Ppi/FirmwareVolume.h | 2 | ||||
-rw-r--r-- | MdePkg/Include/Ppi/FirmwareVolumeInfo.h | 2 | ||||
-rw-r--r-- | MdePkg/Include/Ppi/GuidedSectionExtraction.h | 2 | ||||
-rw-r--r-- | MdePkg/Include/Ppi/LoadImage.h | 2 | ||||
-rw-r--r-- | MdePkg/Include/Ppi/Pcd.h | 2 | ||||
-rw-r--r-- | MdePkg/Include/Ppi/TemporaryRamSupport.h | 2 |
7 files changed, 7 insertions, 7 deletions
diff --git a/MdePkg/Include/Ppi/Decompress.h b/MdePkg/Include/Ppi/Decompress.h index e64661b9c2..1c013bea2d 100644 --- a/MdePkg/Include/Ppi/Decompress.h +++ b/MdePkg/Include/Ppi/Decompress.h @@ -1,4 +1,4 @@ -/* @file
+/** @file
Provides decompression services to the PEI Foundatoin.
Copyright (c) 2006, Intel Corporation
diff --git a/MdePkg/Include/Ppi/FirmwareVolume.h b/MdePkg/Include/Ppi/FirmwareVolume.h index f88beee6ce..33b5ebb70e 100644 --- a/MdePkg/Include/Ppi/FirmwareVolume.h +++ b/MdePkg/Include/Ppi/FirmwareVolume.h @@ -1,4 +1,4 @@ -/* @file
+/** @file
This file provides functions for accessing a memory-mapped firmware volume of a specific format.
Copyright (c) 2006 - 2007, Intel Corporation
diff --git a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h index 8d44a31d4a..e66bfed51b 100644 --- a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h +++ b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h @@ -1,4 +1,4 @@ -/* @file
+/** @file
This file provides location and format of a firmware volume.
Copyright (c) 2006 - 2007, Intel Corporation
diff --git a/MdePkg/Include/Ppi/GuidedSectionExtraction.h b/MdePkg/Include/Ppi/GuidedSectionExtraction.h index 80b1ee1210..d4753f9ac4 100644 --- a/MdePkg/Include/Ppi/GuidedSectionExtraction.h +++ b/MdePkg/Include/Ppi/GuidedSectionExtraction.h @@ -1,4 +1,4 @@ -/* @file
+/** @file
If a GUID-defined section is encountered when doing section extraction,
the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance
calls the appropriate instance of the GUIDed Section Extraction PPI
diff --git a/MdePkg/Include/Ppi/LoadImage.h b/MdePkg/Include/Ppi/LoadImage.h index 5b2ce9acd2..7e0679bd1d 100644 --- a/MdePkg/Include/Ppi/LoadImage.h +++ b/MdePkg/Include/Ppi/LoadImage.h @@ -1,4 +1,4 @@ -/* @file
+/** @file
The file descript the PPI which notifies other drivers
of the PEIM being initialized by the PEI Dispatcher.
diff --git a/MdePkg/Include/Ppi/Pcd.h b/MdePkg/Include/Ppi/Pcd.h index 92ffbb8b07..4d62de64eb 100644 --- a/MdePkg/Include/Ppi/Pcd.h +++ b/MdePkg/Include/Ppi/Pcd.h @@ -1,4 +1,4 @@ -/* @file
+/** @file
Platform Configuration Database (PCD) PPI
Copyright (c) 2006 - 2007, Intel Corporation
diff --git a/MdePkg/Include/Ppi/TemporaryRamSupport.h b/MdePkg/Include/Ppi/TemporaryRamSupport.h index b8d2e7fda5..447c66da56 100644 --- a/MdePkg/Include/Ppi/TemporaryRamSupport.h +++ b/MdePkg/Include/Ppi/TemporaryRamSupport.h @@ -1,4 +1,4 @@ -/* @file
+/** @file
This file declares Temporary RAM Support PPI.
Copyright (c) 2006 - 2007, Intel Corporation
|