Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

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

diff --git a/MdePkg/Include/Protocol/AuthenticationInfo.h b/MdePkg/Include/Protocol/AuthenticationInfo.h
index c491cba1eaed7ed6b5dae1c1c5c42e3fc8b3d439..b5203278347f28dc544f8e1c42bc4e47e0eec247 100644 (file)
--- a/MdePkg/Include/Protocol/AuthenticationInfo.h
+++ b/MdePkg/Include/Protocol/AuthenticationInfo.h
@@ -3,7 +3,7 @@
   This protocol is used on any device handle to obtain authentication information \r
   associated with the physical or logical device.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -35,67 +35,145 @@
 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
-  EFI_IPv6_ADDRESS RadiusIpAddr;             // IPv4 or IPv6 address\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
-  EFI_IPv6_ADDRESS NasIpAddr;                // IPv4 or IPv6 address\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
 /**\r
-  Retrieves the Authentication information associated with a particular controller handle.\r
+  Retrieves the authentication information associated with a particular controller handle.\r
 \r
-  @param  This                   Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
-  @param  ControllerHandle       Handle to the Controller\r
-  @param  Buffer                 Pointer to the authentication information.\r
+  @param  This                  Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
+  @param  ControllerHandle      Handle to the Controller\r
+  @param  Buffer                Pointer to the authentication information.\r
 \r
-  @retval EFI_SUCCESS           Successfully retrieved Authentication information for the given ControllerHandle\r
-  @retval EFI_INVALID_PARAMETER No matching Authentication information found for the given ControllerHandle\r
+  @retval EFI_SUCCESS           Successfully retrieved authentication information for the given ControllerHandle\r
+  @retval EFI_INVALID_PARAMETER No matching authentication information found for the given ControllerHandle\r
   @retval EFI_DEVICE_ERROR      The authentication information could not be retrieved due to a\r
                                 hardware error.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_AUTHENTICATION_PROTOCOL_INFO_GET) (\r
+(EFIAPI *EFI_AUTHENTICATION_PROTOCOL_INFO_GET)(\r
   IN  EFI_AUTHENTICATION_INFO_PROTOCOL *This,\r
   IN  EFI_HANDLE                       *ControllerHandle,\r
   OUT VOID                             *Buffer\r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
-  Set the Authentication information for a given controller handle.\r
+  Set the authentication information for a given controller handle.\r
 \r
-  @param  This                  Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
-  @param  ControllerHandle      Handle to the Controller\r
-  @param  Buffer                Pointer to the authentication information.\r
+  @param  This                 Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
+  @param  ControllerHandle     Handle to the Controller\r
+  @param  Buffer               Pointer to the authentication information.\r
                                 \r
-  @retval EFI_SUCCESS          Successfully set Authentication information for the given ControllerHandle\r
-  @retval EFI_UNSUPPORTED      If the platform policies do not allow setting of the Authentication\r
+  @retval EFI_SUCCESS          Successfully set authentication information for the given ControllerHandle\r
+  @retval EFI_UNSUPPORTED      If the platform policies do not allow setting of the authentication\r
                                information.\r
   @retval EFI_DEVICE_ERROR     The authentication information could not be configured due to a\r
                                hardware error.\r
@@ -104,13 +182,16 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_AUTHENTICATION_PROTOCOL_INFO_SET) (\r
+(EFIAPI *EFI_AUTHENTICATION_PROTOCOL_INFO_SET)(\r
   IN EFI_AUTHENTICATION_INFO_PROTOCOL  *This,\r
   IN EFI_HANDLE                        *ControllerHandle,\r
   IN VOID                              *Buffer\r
-  )\r
-;  \r
+  );  \r
 \r
+///\r
+/// This protocol is used on any device handle to obtain authentication \r
+/// information associated with the physical or logical device.\r
+///\r
 struct _EFI_AUTHENTICATION_INFO_PROTOCOL {\r
   EFI_AUTHENTICATION_PROTOCOL_INFO_GET Get;\r
   EFI_AUTHENTICATION_PROTOCOL_INFO_SET Set;\r