Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/AuthenticationInfo.h b/MdePkg/Include/Protocol/AuthenticationInfo.h
index f80dbf362b9b2fc62356af24ad669fb3372c5095..d2cd444685d30892b422f67b8c8240b40edbe4a5 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
@@ -12,8 +12,6 @@
   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
-  Module Name:  AuthenticationInfo.h\r
-\r
 **/\r
 \r
 #ifndef __AUTHENTICATION_INFO_H__\r
@@ -43,9 +41,9 @@ typedef struct {
 \r
 typedef struct {\r
   AUTH_NODE_HEADER Header;\r
-  EFI_IPv6_ADDRESS RadiusIpAddr;             // IPv4 or IPv6 address\r
+  EFI_IPv6_ADDRESS RadiusIpAddr;             ///< IPv4 or IPv6 address\r
   UINT16           Reserved;\r
-  EFI_IPv6_ADDRESS NasIpAddr;                // IPv4 or IPv6 address\r
+  EFI_IPv6_ADDRESS NasIpAddr;                ///< IPv4 or IPv6 address\r
   UINT16           NasSecretLength; \r
   UINT8            *NasSecret;      \r
   UINT16           ChapSecretLength;\r
@@ -70,9 +68,9 @@ typedef struct {
 /**\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
@@ -82,19 +80,18 @@ typedef struct {
 **/\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
 \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
@@ -106,13 +103,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