Formalize comments for Protocols and PPIs.

[mirror_edk2.git] / MdePkg / Include / Protocol / PxeBaseCode.h

diff --git a/MdePkg/Include/Protocol/PxeBaseCode.h b/MdePkg/Include/Protocol/PxeBaseCode.h
index cda8b4622e7ce975c9209217db60e01139f66279..615007535f90740e07569e0f294846695d05d139 100644 (file)
--- a/MdePkg/Include/Protocol/PxeBaseCode.h
+++ b/MdePkg/Include/Protocol/PxeBaseCode.h
@@ -608,15 +608,14 @@ EFI_STATUS
 // \r
 #define EFI_PXE_BASE_CODE_INTERFACE_REVISION  EFI_PXE_BASE_CODE_PROTOCOL_REVISION\r
 \r
-/**  \r
-  @par Protocol Description:\r
-  The EFI_PXE_BASE_CODE_PROTOCOL is used to control PXE-compatible devices.\r
-  An EFI_PXE_BASE_CODE_PROTOCOL will be layered on top of an\r
-  EFI_MANAGED_NETWORK_PROTOCOL protocol in order to perform packet level transactions.\r
-  The EFI_PXE_BASE_CODE_PROTOCOL handle also supports the\r
-  EFI_LOAD_FILE_PROTOCOL protocol. This provides a clean way to obtain control from the\r
-  boot manager if the boot path is from the remote device.\r
-**/\r
+///\r
+/// The EFI_PXE_BASE_CODE_PROTOCOL is used to control PXE-compatible devices.\r
+/// An EFI_PXE_BASE_CODE_PROTOCOL will be layered on top of an\r
+/// EFI_MANAGED_NETWORK_PROTOCOL protocol in order to perform packet level transactions.\r
+/// The EFI_PXE_BASE_CODE_PROTOCOL handle also supports the\r
+/// EFI_LOAD_FILE_PROTOCOL protocol. This provides a clean way to obtain control from the\r
+/// boot manager if the boot path is from the remote device.\r
+///\r
 struct _EFI_PXE_BASE_CODE_PROTOCOL {\r
   ///\r
   ///  The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must \r
@@ -636,6 +635,9 @@ struct _EFI_PXE_BASE_CODE_PROTOCOL {
   EFI_PXE_BASE_CODE_SET_PARAMETERS  SetParameters;\r
   EFI_PXE_BASE_CODE_SET_STATION_IP  SetStationIp;\r
   EFI_PXE_BASE_CODE_SET_PACKETS     SetPackets;\r
+  ///\r
+  /// Pointer to the EFI_PXE_BASE_CODE_MODE data for this device.\r
+  ///\r
   EFI_PXE_BASE_CODE_MODE            *Mode;\r
 };\r
 \r