Fix doxygen comment for structure and macro

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

diff --git a/MdePkg/Include/Protocol/Bis.h b/MdePkg/Include/Protocol/Bis.h
index eb4f7a60fcce1342ccd2f31fb35b1253c0676b54..f03452e57915fc200ebc3e8d15ce9105566d0210 100644 (file)
--- a/MdePkg/Include/Protocol/Bis.h
+++ b/MdePkg/Include/Protocol/Bis.h
@@ -45,22 +45,20 @@ typedef VOID    *BIS_APPLICATION_HANDLE;
 typedef UINT16  BIS_ALG_ID;\r
 typedef UINT32  BIS_CERT_ID;\r
 \r
-///\r
-/// EFI_BIS_DATA type.\r
 ///\r
 /// EFI_BIS_DATA instances obtained from BIS must be freed by calling Free( ).\r
 ///\r
 typedef struct {\r
-  UINT32  Length; // Length of Data in 8 bit bytes.\r
-  UINT8   *Data;  // 32 Bit Flat Address of data.\r
+  UINT32  Length; ///< Length of Data in 8 bit bytes.\r
+  UINT8   *Data;  ///< 32 Bit Flat Address of data.\r
 } EFI_BIS_DATA;\r
 \r
 ///\r
 /// EFI_BIS_VERSION type.\r
 ///\r
 typedef struct {\r
-  UINT32  Major;  // BIS Interface version number.\r
-  UINT32  Minor;  // Build number.\r
+  UINT32  Major;  ///< BIS Interface version number.\r
+  UINT32  Minor;  ///< Build number.\r
 } EFI_BIS_VERSION;\r
 \r
 //\r
@@ -76,25 +74,25 @@ typedef struct {
 /// EFI_BIS_SIGNATURE_INFO type.\r
 ///\r
 typedef struct {\r
-  BIS_CERT_ID CertificateID;  // Truncated hash of platform Boot Object\r
-  ///  authorization certificate.\r
-  ///\r
-  BIS_ALG_ID  AlgorithmID;  // A signature algorithm number.\r
-  UINT16      KeyLength;    // Length of alg. keys in bits.\r
+  BIS_CERT_ID CertificateID;  ///< Truncated hash of platform Boot Object\r
+  BIS_ALG_ID  AlgorithmID;    ///< A signature algorithm number.\r
+  UINT16      KeyLength;      ///< Length of alg. keys in bits.\r
 } EFI_BIS_SIGNATURE_INFO;\r
 \r
 ///\r
-/// Currently defined values for EFI_BIS_SIGNATURE_INFO.AlgorithmID.\r
+/// values for EFI_BIS_SIGNATURE_INFO.AlgorithmID.\r
 /// The exact numeric values come from\r
 ///    "Common Data Security Architecture (CDSA) Specification".\r
 ///\r
 #define BIS_ALG_DSA     (41)  // CSSM_ALGID_DSA\r
 #define BIS_ALG_RSA_MD5 (42)  // CSSM_ALGID_MD5_WITH_RSA\r
-/// Currently defined values for EFI_BIS_SIGNATURE_INFO.CertificateId.\r
+///\r
+/// values for EFI_BIS_SIGNATURE_INFO.CertificateId.\r
 ///\r
 #define BIS_CERT_ID_DSA     BIS_ALG_DSA     // CSSM_ALGID_DSA\r
 #define BIS_CERT_ID_RSA_MD5 BIS_ALG_RSA_MD5 // CSSM_ALGID_MD5_WITH_RSA\r
-/// The  following  is a mask value that gets applied to the truncated hash of a\r
+///\r
+/// the mask value that gets applied to the truncated hash of a\r
 /// platform  Boot Object Authorization Certificate to create the certificateID.\r
 /// A certificateID must not have any bits set to the value 1 other than bits in\r
 /// this mask.\r
@@ -403,55 +401,6 @@ EFI_STATUS
   @par Protocol Description:\r
   The EFI_BIS_PROTOCOL is used to check a digital signature of a data block against a digital\r
   certificate for the purpose of an integrity and authorization check.\r
-\r
-  @param initialize\r
-  Initializes an application instance of the EFI_BIS protocol,\r
-  returning a handle for the application instance. Other functions in\r
-  the EFI_BIS protocol require a valid application instance\r
-  handle obtained from this function.\r
-  \r
-  @param Shutdown \r
-  Ends the lifetime of an application instance of the EFI_BIS\r
-  protocol, invalidating its application instance handle. The\r
-  application instance handle may no longer be used in other\r
-  functions in the EFI_BIS protocol.\r
-\r
-  @param Free \r
-  Frees memory structures allocated and returned by other\r
-  functions in the EFI_BIS protocol. \r
-\r
-  @param GetBootObjectAuthorizationCertificate\r
-  Retrieves the current digital certificate (if any) used by the\r
-  EFI_BIS protocol as the source of authorization for verifying\r
-  boot objects and altering configuration parameters.\r
-\r
-  @param GetBootObjectAuthorizationCheckFlag\r
-  Retrieves the current setting of the authorization check flag that\r
-  indicates whether or not authorization checks are required for\r
-  boot objects.\r
-\r
-  @param GetBootObjectAuthorizationUpdateToken\r
-  Retrieves an uninterpreted token whose value gets included and\r
-  signed in a subsequent request to alter the configuration\r
-  parameters, to protect against attempts to replay such a request.\r
-\r
-  @param GetSignatureInfo \r
-  Retrieves information about the digital signature algorithms\r
-  supported and the identity of the installed authorization\r
-  certificate, if any.\r
-\r
-  @param UpdateBootObjectAuthorization\r
-  Requests that the configuration parameters be altered by\r
-  installing or removing an authorization certificate or changing the\r
-  setting of the check flag. \r
-\r
-  @param VerifyBootObject\r
-  Verifies a boot object according to the supplied digital signature\r
-  and the current authorization certificate and check flag setting.\r
-\r
-  @param VerifyObjectWithCredential\r
-  Verifies a data object according to a supplied digital signature\r
-  and a supplied digital certificate.  \r
 **/\r
 struct _EFI_BIS_PROTOCOL {\r
   EFI_BIS_INITIALIZE                                  Initialize;\r