Adjust doxygen comment style for structure.

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

diff --git a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
index 0a6429c2066dccd0a988b09b6a1629308362155b..dc6665934882c8af9a2cbace52e56b7050dd6d07 100644 (file)
--- a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
+++ b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
@@ -288,63 +288,42 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {
   used.\r
 **/\r
 typedef struct {\r
-  ///\r
-  ///  A pointer to the DMTF SM CLP command line null-terminated string that the \r
-  ///  driver is required to parse and process when this EFI_SUCCESS The platform \r
-  ///  return parameter information for ControllerHandle. EFI_NOT_FOUND Instance \r
-  ///  was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid \r
-  ///  EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. function is called. \r
-  ///  See the DMTF SM CLP Specification 1.0 Final Standard for details on the \r
-  ///  format and syntax of the CLP command line string. CLPCommand buffer\r
-  ///  is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.\r
-  ///\r
-  CHAR8   *CLPCommand;\r
-  \r
-  ///\r
-  /// The length of the CLP Command in bytes.\r
-  ///\r
-  UINT32  CLPCommandLength;\r
-  \r
-  ///\r
-  ///  A pointer to the CLP return status string that the driver is required to\r
-  ///  provide to the calling agent. The calling agent may parse and/ or pass\r
-  ///  this for processing and user feedback. The SM CLP Command Response string\r
-  ///  buffer is filled in by the UEFI driver in the "keyword=value" format\r
-  ///  described in the SM CLP Specification, unless otherwise requested via the SM\r
-  ///  CLP Coutput option in the Command Line string buffer. UEFI driver's support\r
-  ///  for this default "keyword=value" output format is required if the UEFI\r
-  ///  driver supports this protocol, while support for other SM CLP output\r
-  ///  formats is optional (the UEFI Driver should return an EFI_UNSUPPORTED if\r
-  ///  the SM CLP Coutput option requested by the caller is not supported by the\r
-  ///  UEFI Driver). CLPReturnString buffer is allocated by the consumer of the\r
-  ///  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to\r
-  ///  Response().  \r
-  ///\r
-  CHAR8   *CLPReturnString;\r
-  \r
-  ///\r
-  /// The length of the CLP return status string in bytes.\r
-  ///\r
-  UINT32  CLPReturnStringLength;\r
-  \r
-  ///\r
-  ///  SM CLP Command Status (see DMTF SM CLP Specification 1.0 Final Standard -\r
-  ///  Table 4) CLPErrorValue SM CLP Processing Error Value (see DMTF SM\r
-  ///  CLP Specification 1.0 Final Standard - Table 6). This field is filled in by\r
-  ///  the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC \r
-  ///  OL and undefined prior to the call to Response().  \r
-  ///\r
-  UINT8   CLPCmdStatus;\r
-  UINT8   CLPErrorValue;\r
-  \r
-  ///\r
-  ///  Bit 15: OEM Message Code Flag 0 = Message Code is an SM CLP Probable\r
-  ///  Cause Value. (see SM CLP Specification Table 11) 1 = Message Code is OEM\r
-  ///  Specific Bits 14-0: Message Code This field is filled in by the consumer of\r
-  ///  the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to\r
-  ///  Response(). \r
-  /// \r
-  UINT16  CLPMsgCode;\r
+  CHAR8   *CLPCommand;        ///<  A pointer to the DMTF SM CLP command line null-terminated string that the \r
+                              ///<  driver is required to parse and process when this EFI_SUCCESS The platform \r
+                              ///<  return parameter information for ControllerHandle. EFI_NOT_FOUND Instance \r
+                              ///<  was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid \r
+                              ///<  EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. function is called. \r
+                              ///<  See the DMTF SM CLP Specification 1.0 Final Standard for details on the \r
+                              ///<  format and syntax of the CLP command line string. CLPCommand buffer\r
+                              ///<  is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.\r
+  UINT32  CLPCommandLength;   ///< The length of the CLP Command in bytes.\r
+  CHAR8   *CLPReturnString;   ///<  A pointer to the CLP return status string that the driver is required to\r
+                              ///<  provide to the calling agent. The calling agent may parse and/ or pass\r
+                              ///<  this for processing and user feedback. The SM CLP Command Response string\r
+                              ///<  buffer is filled in by the UEFI driver in the "keyword=value" format\r
+                              ///<  described in the SM CLP Specification, unless otherwise requested via the SM\r
+                              ///<  CLP Coutput option in the Command Line string buffer. UEFI driver's support\r
+                              ///<  for this default "keyword=value" output format is required if the UEFI\r
+                              ///<  driver supports this protocol, while support for other SM CLP output\r
+                              ///<  formats is optional (the UEFI Driver should return an EFI_UNSUPPORTED if\r
+                              ///<  the SM CLP Coutput option requested by the caller is not supported by the\r
+                              ///<  UEFI Driver). CLPReturnString buffer is allocated by the consumer of the\r
+                              ///<  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to\r
+                              ///<  Response().  \r
+  UINT32  CLPReturnStringLength; ///< The length of the CLP return status string in bytes.\r
+  UINT8   CLPCmdStatus;       ///<  SM CLP Command Status (see DMTF SM CLP Specification 1.0 Final Standard -\r
+                              ///<  Table 4) CLPErrorValue SM CLP Processing Error Value (see DMTF SM\r
+                              ///<  CLP Specification 1.0 Final Standard - Table 6). This field is filled in by\r
+                              ///<  the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC \r
+                              ///<  OL and undefined prior to the call to Response().  \r
+  UINT8   CLPErrorValue;      ///<  SM CLP Processing Error Value (see DMTF SM CLP Specification 1.0 Final Standard - Table 6).\r
+                              ///<  This field is filled in by the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL and undefined prior to the call to Response().                              \r
+  UINT16  CLPMsgCode;         ///<  Bit 15: OEM Message Code Flag 0 = Message Code is an SM CLP Probable\r
+                              ///<  Cause Value. (see SM CLP Specification Table 11) 1 = Message Code is OEM\r
+                              ///<  Specific Bits 14-0: Message Code This field is filled in by the consumer of\r
+                              ///<  the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to\r
+                              ///<  Response(). \r
+\r
 } EFI_CONFIGURE_CLP_PARAMETER_BLK;\r
 \r
 \r

diff --git a/MdePkg/Include/Protocol/Runtime.h b/MdePkg/Include/Protocol/Runtime.h
index dc56ec6be930dc10d9fba7555a68ba1ae82404b2..718f9dca5c2fe61122ea8ffc7a8153e5a2a0f088 100644 (file)
--- a/MdePkg/Include/Protocol/Runtime.h
+++ b/MdePkg/Include/Protocol/Runtime.h
@@ -72,51 +72,16 @@ struct _EFI_RUNTIME_EVENT_ENTRY {
 /// by a runtime DXE driver and may only be consumed by the DXE Foundation.\r
 ///\r
 struct _EFI_RUNTIME_ARCH_PROTOCOL {\r
-  ///\r
-  /// A list of type EFI_RUNTIME_IMAGE_ENTRY.\r
-  ///\r
-  EFI_LIST_ENTRY          ImageHead;\r
-  \r
-  ///\r
-  /// A list of type EFI_RUNTIME_EVENT_ENTRY.\r
-  ///\r
-  EFI_LIST_ENTRY          EventHead;\r
-  \r
-  ///\r
-  /// Size of a memory descriptor that is return by GetMemoryMap().\r
-  ///\r
-  UINTN                   MemoryDescriptorSize;\r
-  \r
-  ///\r
-  /// Version of a memory descriptor that is return by GetMemoryMap().\r
-  ///\r
-  UINT32                  MemoryDesciptorVersion;\r
-  \r
-  ///\r
-  /// Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual. \r
-  ///\r
-  UINTN                   MemoryMapSize;\r
-  \r
-  ///\r
-  /// Pointer to a runtime buffer that contains a copy of \r
-  /// the memory map returned via GetMemoryMap().\r
-  ///\r
-  EFI_MEMORY_DESCRIPTOR   *MemoryMapPhysical;\r
-  \r
-  ///\r
-  /// Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().\r
-  ///\r
-  EFI_MEMORY_DESCRIPTOR   *MemoryMapVirtual;\r
-  \r
-  ///\r
-  /// Boolean that is TRUE if SetVirtualAddressMap() has been called.\r
-  ///\r
-  BOOLEAN                 VirtualMode;\r
-  \r
-  ///\r
-  /// Boolean that is TRUE if ExitBootServices () has been called.\r
-  ///\r
-  BOOLEAN                 AtRuntime;\r
+  EFI_LIST_ENTRY          ImageHead;    ///< A list of type EFI_RUNTIME_IMAGE_ENTRY.\r
+  EFI_LIST_ENTRY          EventHead;    ///< A list of type EFI_RUNTIME_EVENT_ENTRY.\r
+  UINTN                   MemoryDescriptorSize;   ///< Size of a memory descriptor that is return by GetMemoryMap().\r
+  UINT32                  MemoryDesciptorVersion; ///< Version of a memory descriptor that is return by GetMemoryMap().\r
+  UINTN                   MemoryMapSize;///< Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual. \r
+  EFI_MEMORY_DESCRIPTOR   *MemoryMapPhysical;     ///< Pointer to a runtime buffer that contains a copy of \r
+                                                  ///< the memory map returned via GetMemoryMap().\r
+  EFI_MEMORY_DESCRIPTOR   *MemoryMapVirtual;      ///< Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().\r
+  BOOLEAN                 VirtualMode;  ///< Boolean that is TRUE if SetVirtualAddressMap() has been called.\r
+  BOOLEAN                 AtRuntime;    ///< Boolean that is TRUE if ExitBootServices () has been called.\r
 };\r
 \r
 extern EFI_GUID gEfiRuntimeArchProtocolGuid;\r