Adjust doxygen comment style for structure.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6178 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 36 insertions, 57 deletions

diff --git a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
index 0a6429c206..dc66659348 100644
--- a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
+++ b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
@@ -288,63 +288,42 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {
   used.

 **/

 typedef struct {

-  ///

-  ///  A pointer to the DMTF SM CLP command line null-terminated string that the 

-  ///  driver is required to parse and process when this EFI_SUCCESS The platform 

-  ///  return parameter information for ControllerHandle. EFI_NOT_FOUND Instance 

-  ///  was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid 

-  ///  EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. function is called. 

-  ///  See the DMTF SM CLP Specification 1.0 Final Standard for details on the 

-  ///  format and syntax of the CLP command line string. CLPCommand buffer

-  ///  is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.

-  ///

-  CHAR8   *CLPCommand;

-  

-  ///

-  /// The length of the CLP Command in bytes.

-  ///

-  UINT32  CLPCommandLength;

-  

-  ///

-  ///  A pointer to the CLP return status string that the driver is required to

-  ///  provide to the calling agent. The calling agent may parse and/ or pass

-  ///  this for processing and user feedback. The SM CLP Command Response string

-  ///  buffer is filled in by the UEFI driver in the "keyword=value" format

-  ///  described in the SM CLP Specification, unless otherwise requested via the SM

-  ///  CLP Coutput option in the Command Line string buffer. UEFI driver's support

-  ///  for this default "keyword=value" output format is required if the UEFI

-  ///  driver supports this protocol, while support for other SM CLP output

-  ///  formats is optional (the UEFI Driver should return an EFI_UNSUPPORTED if

-  ///  the SM CLP Coutput option requested by the caller is not supported by the

-  ///  UEFI Driver). CLPReturnString buffer is allocated by the consumer of the

-  ///  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to

-  ///  Response().  

-  ///

-  CHAR8   *CLPReturnString;

-  

-  ///

-  /// The length of the CLP return status string in bytes.

-  ///

-  UINT32  CLPReturnStringLength;

-  

-  ///

-  ///  SM CLP Command Status (see DMTF SM CLP Specification 1.0 Final Standard -

-  ///  Table 4) CLPErrorValue SM CLP Processing Error Value (see DMTF SM

-  ///  CLP Specification 1.0 Final Standard - Table 6). This field is filled in by

-  ///  the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC 

-  ///  OL and undefined prior to the call to Response().  

-  ///

-  UINT8   CLPCmdStatus;

-  UINT8   CLPErrorValue;

-  

-  ///

-  ///  Bit 15: OEM Message Code Flag 0 = Message Code is an SM CLP Probable

-  ///  Cause Value. (see SM CLP Specification Table 11) 1 = Message Code is OEM

-  ///  Specific Bits 14-0: Message Code This field is filled in by the consumer of

-  ///  the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to

-  ///  Response(). 

-  /// 

-  UINT16  CLPMsgCode;

+  CHAR8   *CLPCommand;        ///<  A pointer to the DMTF SM CLP command line null-terminated string that the 

+                              ///<  driver is required to parse and process when this EFI_SUCCESS The platform 

+                              ///<  return parameter information for ControllerHandle. EFI_NOT_FOUND Instance 

+                              ///<  was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid 

+                              ///<  EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. function is called. 

+                              ///<  See the DMTF SM CLP Specification 1.0 Final Standard for details on the 

+                              ///<  format and syntax of the CLP command line string. CLPCommand buffer

+                              ///<  is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.

+  UINT32  CLPCommandLength;   ///< The length of the CLP Command in bytes.

+  CHAR8   *CLPReturnString;   ///<  A pointer to the CLP return status string that the driver is required to

+                              ///<  provide to the calling agent. The calling agent may parse and/ or pass

+                              ///<  this for processing and user feedback. The SM CLP Command Response string

+                              ///<  buffer is filled in by the UEFI driver in the "keyword=value" format

+                              ///<  described in the SM CLP Specification, unless otherwise requested via the SM

+                              ///<  CLP Coutput option in the Command Line string buffer. UEFI driver's support

+                              ///<  for this default "keyword=value" output format is required if the UEFI

+                              ///<  driver supports this protocol, while support for other SM CLP output

+                              ///<  formats is optional (the UEFI Driver should return an EFI_UNSUPPORTED if

+                              ///<  the SM CLP Coutput option requested by the caller is not supported by the

+                              ///<  UEFI Driver). CLPReturnString buffer is allocated by the consumer of the

+                              ///<  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to

+                              ///<  Response().  

+  UINT32  CLPReturnStringLength; ///< The length of the CLP return status string in bytes.

+  UINT8   CLPCmdStatus;       ///<  SM CLP Command Status (see DMTF SM CLP Specification 1.0 Final Standard -

+                              ///<  Table 4) CLPErrorValue SM CLP Processing Error Value (see DMTF SM

+                              ///<  CLP Specification 1.0 Final Standard - Table 6). This field is filled in by

+                              ///<  the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC 

+                              ///<  OL and undefined prior to the call to Response().  

+  UINT8   CLPErrorValue;      ///<  SM CLP Processing Error Value (see DMTF SM CLP Specification 1.0 Final Standard - Table 6).

+                              ///<  This field is filled in by the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL and undefined prior to the call to Response().                              

+  UINT16  CLPMsgCode;         ///<  Bit 15: OEM Message Code Flag 0 = Message Code is an SM CLP Probable

+                              ///<  Cause Value. (see SM CLP Specification Table 11) 1 = Message Code is OEM

+                              ///<  Specific Bits 14-0: Message Code This field is filled in by the consumer of

+                              ///<  the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to

+                              ///<  Response(). 

+

 } EFI_CONFIGURE_CLP_PARAMETER_BLK;