diff options
author | xli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-13 02:54:29 +0000 |
---|---|---|
committer | xli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-13 02:54:29 +0000 |
commit | 44717a398fddc4df1f4aeaa70bcd7a043187ed34 (patch) | |
tree | b41f68d9d59c300d71efeeba5a12acc1bbcfb593 /MdePkg/Include/Protocol/PlatformToDriverConfiguration.h | |
parent | 66eebcf94f14a0888a09f6fe5aca16563411becf (diff) | |
download | edk2-platforms-44717a398fddc4df1f4aeaa70bcd7a043187ed34.tar.xz |
Formalize comments for Protocols and PPIs.
1. Use doxygen format for Protocol/PPI data structure
2. Remove doxygen comments for function elements in Protocol/Ppi
3. Use doxygen format for data elements in Protocol/Ppi, and add missing comments where necessary
4. PEI Services Table is also updated accordingly.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6107 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/PlatformToDriverConfiguration.h')
-rw-r--r-- | MdePkg/Include/Protocol/PlatformToDriverConfiguration.h | 35 |
1 files changed, 12 insertions, 23 deletions
diff --git a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h index 7883028f10..0a6429c206 100644 --- a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h +++ b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h @@ -253,29 +253,18 @@ EFI_STATUS );
-/**
- @par Protocol Description:
- The EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is used by the
- UEFI driver to query the platform for configuration information.
- The UEFI driver calls Query() multiple times to get
- configuration information from the platform. For every call to
- Query() there must be a matching call to Response() so the
- UEFI driver can inform the platform how it used the
- information passed in from Query(). It's legal for a UEFI
- driver to use Response() to inform the platform it does not
- understand the data returned via Query() and thus no action was
- taken.
-
- @param Query Called by the UEFI Driver Start() function to
- get configuration information from the
- platform.
-
- @param Response Called by the UEFI Driver Start() function
- to let the platform know how UEFI driver
- processed the data return from Query.
-
-
-**/
+///
+/// The EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is used by the
+/// UEFI driver to query the platform for configuration information.
+/// The UEFI driver calls Query() multiple times to get
+/// configuration information from the platform. For every call to
+/// Query() there must be a matching call to Response() so the
+/// UEFI driver can inform the platform how it used the
+/// information passed in from Query(). It's legal for a UEFI
+/// driver to use Response() to inform the platform it does not
+/// understand the data returned via Query() and thus no action was
+/// taken.
+///
struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {
EFI_PLATFORM_TO_DRIVER_CONFIGURATION_QUERY Query;
EFI_PLATFORM_TO_DRIVER_CONFIGURATION_RESPONSE Response;
|