Grammatical and disclaimer changes (does not follow internal C coding stds.)

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

diff --git a/MdePkg/Include/Protocol/AuthenticationInfo.h b/MdePkg/Include/Protocol/AuthenticationInfo.h
index a3c9b973771637a567ffde1c7cd91937939c5c2c..b70ab9dafb7b8b96bd34c21aecd1236f388874cb 100644 (file)
--- a/MdePkg/Include/Protocol/AuthenticationInfo.h
+++ b/MdePkg/Include/Protocol/AuthenticationInfo.h
@@ -3,14 +3,14 @@
   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 - 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
-  http://opensource.org/licenses/bsd-license.php                                            \r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                          \r
+    \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
 \r
 **/\r
 \r
@@ -51,19 +51,19 @@ typedef struct {
   AUTH_NODE_HEADER Header;\r
 \r
   ///\r
-  /// RADIUS Server IPv4 or IPv6 Address\r
+  /// RADIUS Server IPv4 or IPv6 Address.\r
   ///\r
-  UINT8            RadiusIpAddr[16];         ///< IPv4 or IPv6 address\r
+  UINT8            RadiusIpAddr[16];         ///< IPv4 or IPv6 address.\r
 \r
   ///\r
-  /// Reserved for future use\r
+  /// Reserved for future use.\r
   ///\r
   UINT16           Reserved;\r
 \r
   ///\r
-  /// Network Access Server IPv4 or IPv6 Address (OPTIONAL)\r
+  /// Network Access Server IPv4 or IPv6 Address (OPTIONAL).\r
   ///\r
-  UINT8            NasIpAddr[16];            ///< IPv4 or IPv6 address\r
+  UINT8            NasIpAddr[16];            ///< IPv4 or IPv6 address.\r
 \r
   ///\r
   /// Network Access Server Secret Length in bytes (OPTIONAL)\r
@@ -71,7 +71,7 @@ typedef struct {
   UINT16           NasSecretLength; \r
 \r
   ///\r
-  /// Network Access Server Secret (OPTIONAL)\r
+  /// Network Access Server Secret (OPTIONAL).\r
   ///\r
   UINT8            NasSecret[1];\r
 \r
@@ -84,7 +84,7 @@ typedef struct {
   ///\r
   /// UINT8            ChapSecret[];\r
   ///\r
-  /// CHAP Initiator Name Length in bytes on offset ChapSecret + ChapSecretLength\r
+  /// CHAP Initiator Name Length in bytes on offset ChapSecret + ChapSecretLength.\r
   ///\r
   /// UINT16           ChapNameLength;\r
   ///\r
@@ -98,22 +98,22 @@ typedef struct {
   AUTH_NODE_HEADER Header;\r
 \r
   ///\r
-  /// Reserved for future use\r
+  /// Reserved for future use.\r
   ///\r
   UINT16           Reserved;\r
 \r
   ///\r
-  /// User Secret Length in bytes\r
+  /// User Secret Length in bytes.\r
   ///\r
   UINT16           UserSecretLength;\r
 \r
   ///\r
-  /// User Secret\r
+  /// User Secret.\r
   ///\r
   UINT8            UserSecret[1];\r
 \r
   ///\r
-  /// User Name Length in bytes on offset UserSecret + UserSecretLength\r
+  /// User Name Length in bytes on offset UserSecret + UserSecretLength.\r
   ///\r
   /// UINT16           UserNameLength;\r
   ///\r
@@ -143,14 +143,16 @@ typedef struct {
 /**\r
   Retrieves the authentication information associated with a particular controller handle.\r
 \r
-  @param[in]  This                  Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
-  @param[in]  ControllerHandle      Handle to the Controller\r
-  @param[out] Buffer                Pointer to the authentication information.\r
+  @param[in]  This                  The pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL.\r
+  @param[in]  ControllerHandle      The handle to the Controller.\r
+  @param[out] Buffer                The 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_DEVICE_ERROR      The authentication information could not be retrieved due to a\r
-                                hardware error.\r
+  @retval EFI_SUCCESS           Successfully retrieved authentication information \r
+                                for the given ControllerHandle.\r
+  @retval EFI_INVALID_PARAMETER No matching authentication information found for \r
+                                the given ControllerHandle.\r
+  @retval EFI_DEVICE_ERROR      The authentication information could not be retrieved \r
+                                due to a hardware error.\r
 \r
 **/\r
 typedef\r
@@ -164,15 +166,16 @@ EFI_STATUS
 /**\r
   Set the authentication information for a given controller handle.\r
 \r
-  @param[in]  This                 Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
-  @param[in]  ControllerHandle     Handle to the Controller\r
-  @param[in]  Buffer               Pointer to the authentication information.\r
+  @param[in]  This                 The pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL.\r
+  @param[in]  ControllerHandle     The handle to the Controller.\r
+  @param[in]  Buffer               The 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
-                               information.\r
-  @retval EFI_DEVICE_ERROR     The authentication information could not be configured due to a\r
-                               hardware error.\r
+  @retval EFI_SUCCESS          Successfully set authentication information for the \r
+                               given ControllerHandle.\r
+  @retval EFI_UNSUPPORTED      If the platform policies do not allow setting of \r
+                               the authentication information.\r
+  @retval EFI_DEVICE_ERROR     The authentication information could not be configured \r
+                               due to a hardware error.\r
   @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.\r
 \r
 **/\r