summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
diff options
context:
space:
mode:
authorvanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>2009-06-11 01:46:51 +0000
committervanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>2009-06-11 01:46:51 +0000
commitf754f721bf10508ca15c5c9243caa39c765662cf (patch)
treea30263d31dbc5cbe0d472c1ae870702d19111892 /MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
parent41f2ff0b85f3118238aeac8dfda3a657340519a5 (diff)
downloadedk2-platforms-f754f721bf10508ca15c5c9243caa39c765662cf.tar.xz
update codes per MdePkg doxgen review comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8526 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/PlatformToDriverConfiguration.h')
-rw-r--r--MdePkg/Include/Protocol/PlatformToDriverConfiguration.h44
1 files changed, 22 insertions, 22 deletions
diff --git a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
index 6c974caf64..628873c59e 100644
--- a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
+++ b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
@@ -76,7 +76,7 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
should not attempt to free ParameterTypeGuid.
@param ParameterBlock The platform returns a pointer to the
- ParameterBlock structure, which
+ ParameterBlock structure which
contains details about the
configuration parameters specific to
the ParameterTypeGuid. This structure
@@ -85,7 +85,7 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
protocols. UEFI driver decodes this
structure and its contents based on
ProtocolGuid. ParameterBlock is
- allocated by the platform. The
+ allocated by the platform and the
platform is responsible for freeing
the ParameterBlock after Result is
called.
@@ -201,33 +201,33 @@ typedef enum {
ParameterTypeGuid. The platform is responsible for freeing
ParameterBlock and the UEFI driver must not try to free it.
- @param This A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.
+ @param This A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.
- @param ControllerHandle The handle the driver is returning
- configuration information about.
+ @param ControllerHandle The handle the driver is returning
+ configuration information about.
- @param ChildHandle The handle of the child controller to
- return information on. This is an optional
- parameter that may be NULL. It will be
- NULL for device drivers, and for bus
- drivers that attempt to get options for
- the bus controller. It will not be NULL
- for a bus driver that attempts to get
- options for one of its child controllers.
- Instance Instance data returned from
- Query().
+ @param ChildHandle The handle of the child controller to
+ return information on. This is an optional
+ parameter that may be NULL. It will be
+ NULL for device drivers, and for bus
+ drivers that attempt to get options for
+ the bus controller. It will not be NULL
+ for a bus driver that attempts to get
+ options for one of its child controllers.
+ Instance Instance data returned from
+ Query().
- @param Instance Instance data passed to Query().
+ @param Instance Instance data passed to Query().
- @param ParameterTypeGuid ParameterTypeGuid returned from Query.
+ @param ParameterTypeGuid ParameterTypeGuid returned from Query.
- @param ParameterBlock ParameterBlock returned from Query.
+ @param ParameterBlock ParameterBlock returned from Query.
- @param ParameterBlockSize The ParameterBlock size returned from Query.
+ @param ParameterBlockSize The ParameterBlock size returned from Query.
- @param ConfigurationAction The driver tells the platform what
- action is required for ParameterBlock to
- take effect.
+ @param ConfigurationAction The driver tells the platform what
+ action is required for ParameterBlock to
+ take effect.
@retval EFI_SUCCESS The platform return parameter information