Update comments for Protocol definitions to match UEFI spec. And add the missing...

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

diff --git a/MdePkg/Include/Protocol/AuthenticationInfo.h b/MdePkg/Include/Protocol/AuthenticationInfo.h
index d2cd444685d30892b422f67b8c8240b40edbe4a5..8f62bc99cf4143b565d0d4070ab804ddb67fedc9 100644 (file)
--- a/MdePkg/Include/Protocol/AuthenticationInfo.h
+++ b/MdePkg/Include/Protocol/AuthenticationInfo.h
@@ -35,33 +35,112 @@
 typedef struct _EFI_AUTHENTICATION_INFO_PROTOCOL EFI_AUTHENTICATION_INFO_PROTOCOL;\r
 \r
 typedef struct {\r
+  ///\r
+  /// Authentication Type GUID.\r
+  ///\r
   EFI_GUID         Guid;\r
+\r
+  ///\r
+  /// Length of this structure in bytes.\r
+  ///\r
   UINT16           Length;\r
 } AUTH_NODE_HEADER;\r
 \r
 typedef struct {\r
   AUTH_NODE_HEADER Header;\r
+\r
+  ///\r
+  /// RADIUS Server IPv4 or IPv6 Address\r
+  ///\r
   EFI_IPv6_ADDRESS RadiusIpAddr;             ///< IPv4 or IPv6 address\r
+\r
+  ///\r
+  /// Reserved for future use\r
+  ///\r
   UINT16           Reserved;\r
+\r
+  ///\r
+  /// Network Access Server IPv4 or IPv6 Address (OPTIONAL)\r
+  ///\r
   EFI_IPv6_ADDRESS NasIpAddr;                ///< IPv4 or IPv6 address\r
+\r
+  ///\r
+  /// Network Access Server Secret Length in bytes (OPTIONAL)\r
+  ///\r
   UINT16           NasSecretLength; \r
+\r
+  ///\r
+  /// Network Access Server secret (OPTIONAL)\r
+  ///\r
   UINT8            *NasSecret;      \r
+\r
+  ///\r
+  /// CHAP Initiator Secret length in bytes\r
+  ///\r
   UINT16           ChapSecretLength;\r
+\r
+  ///\r
+  /// CHAP Initiator Secret\r
+  ///\r
   UINT8            *ChapSecret;\r
+\r
+  ///\r
+  /// CHAP Initiator Name Length in bytes\r
+  ///\r
   UINT16           ChapNameLength;\r
+\r
+  ///\r
+  /// CHAP Initiator Name\r
+  ///\r
   UINT8            *ChapName;\r
 } CHAP_RADIUS_AUTH_NODE;\r
 \r
 typedef struct {\r
   AUTH_NODE_HEADER Header;\r
+\r
+  ///\r
+  /// Reserved for future use\r
+  ///\r
   UINT16           Reserved;\r
+\r
+  ///\r
+  /// User Secret Length in bytes\r
+  ///\r
   UINT16           UserSecretLength;\r
+\r
+  ///\r
+  /// User Secret\r
+  ///\r
   UINT8            *UserSecret;     \r
+\r
+  ///\r
+  /// User Name Length in bytes\r
+  ///\r
   UINT16           UserNameLength;\r
+\r
+  ///\r
+  /// User Name\r
+  ///\r
   UINT8            *UserName;\r
+\r
+  ///\r
+  /// CHAP Initiator Secret length in bytes\r
+  ///\r
   UINT16           ChapSecretLength;\r
+\r
+  ///\r
+  /// CHAP Initiator Secret\r
+  ///\r
   UINT8            *ChapSecret;\r
+\r
+  ///\r
+  /// CHAP Initiator Name Length in bytes\r
+  ///\r
   UINT16           ChapNameLength;\r
+\r
+  ///\r
+  /// CHAP Initiator Name\r
+  ///\r
   UINT8            *ChapName;\r
 } CHAP_LOCAL_AUTH_NODE;\r
 \r