Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / DiskInfo.h

diff --git a/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h b/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
index 833072fc894bc323cbbd8372d09ddd065ff1086d..b6695e16552b324b29fef553e469f9d3e170dfb3 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
@@ -30,20 +30,20 @@ typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;
   This function is used by the IDE bus driver to get inquiry data. \r
   Data format of Identify data is defined by the Interface GUID.\r
 \r
-  @param  This                  Protocol instance pointer. \r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
   @param  InquiryData           Pointer to a buffer for the inquiry data.\r
   @param  InquiryDataSize       Pointer to the value for the inquiry data size.\r
 \r
   @retval EFI_SUCCESS           The command was accepted without any errors.\r
   @retval EFI_NOT_FOUND         Device does not support this data class \r
   @retval EFI_DEVICE_ERROR      Error reading InquiryData from device \r
-  @retval EFI_BUFFER_TOO_SMALL  IntquiryDataSize not big enough \r
+  @retval EFI_BUFFER_TOO_SMALL  InquiryDataSize not big enough \r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_DISK_INFO_INQUIRY)(\r
-  IN EFI_DISK_INFO_PROTOCOL           * This,\r
+  IN EFI_DISK_INFO_PROTOCOL           *This,\r
   IN OUT VOID                         *InquiryData,\r
   IN OUT UINT32                       *InquiryDataSize\r
   );\r
@@ -53,7 +53,7 @@ EFI_STATUS
   This function is used by the IDE bus driver to get identify data. \r
   Data format of Identify data is defined by the Interface GUID.\r
 \r
-  @param  This                  Protocol instance pointer. \r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
   @param  IdentifyData          Pointer to a buffer for the identify data.\r
   @param  IdentifyDataSize      Pointer to the value for the identify data size.\r
 \r
@@ -66,7 +66,7 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_DISK_INFO_IDENTIFY)(\r
-  IN EFI_DISK_INFO_PROTOCOL           * This,\r
+  IN EFI_DISK_INFO_PROTOCOL           *This,\r
   IN OUT VOID                         *IdentifyData,\r
   IN OUT UINT32                       *IdentifyDataSize\r
   );\r
@@ -76,7 +76,7 @@ EFI_STATUS
   This function is used by the IDE bus driver to get sense data. \r
   Data format of Sense data is defined by the Interface GUID.\r
 \r
-  @param  This                  Protocol instance pointer. \r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
   @param  SenseData             Pointer to the SenseData. \r
   @param  SenseDataSize         Size of SenseData in bytes. \r
   @param  SenseDataNumber       Pointer to the value for the identify data size.\r
@@ -90,7 +90,7 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_DISK_INFO_SENSE_DATA)(\r
-  IN EFI_DISK_INFO_PROTOCOL           * This,\r
+  IN EFI_DISK_INFO_PROTOCOL           *This,\r
   IN OUT VOID                         *SenseData,\r
   IN OUT UINT32                       *SenseDataSize,\r
   OUT UINT8                           *SenseDataNumber\r
@@ -99,7 +99,7 @@ EFI_STATUS
 /**\r
   This function is used by the IDE bus driver to get controller information.\r
 \r
-  @param  This                  Protocol instance pointer. \r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
   @param  IdeChannel            Pointer to the Ide Channel number. Primary or secondary.\r
   @param  IdeDevice             Pointer to the Ide Device number. Master or slave.\r
 \r
@@ -110,7 +110,7 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_DISK_INFO_WHICH_IDE)(\r
-  IN EFI_DISK_INFO_PROTOCOL           * This,\r
+  IN EFI_DISK_INFO_PROTOCOL           *This,\r
   OUT UINT32                          *IdeChannel,\r
   OUT UINT32                          *IdeDevice\r
   );\r