Minor grammatical work--mostly adding periods. Items with ONLY period added did...

[mirror_edk2.git] / MdePkg / Library / DxeSmbusLib / SmbusLib.c

diff --git a/MdePkg/Library/DxeSmbusLib/SmbusLib.c b/MdePkg/Library/DxeSmbusLib/SmbusLib.c
index f89d5641461162450917e69ee842d6eced98c0b3..58733e6ee4c59ff6729c9a33ebd21cbfb83472e0 100644 (file)
--- a/MdePkg/Library/DxeSmbusLib/SmbusLib.c
+++ b/MdePkg/Library/DxeSmbusLib/SmbusLib.c
@@ -26,7 +26,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r

-  @param  SmBusAddress  Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress  The address that encodes the SMBUS Slave Address,\r

                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r


@@ -65,7 +65,7 @@ SmBusQuickRead (
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r

-  @param  SmBusAddress  Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress  The address that encodes the SMBUS Slave Address,\r

                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r


@@ -104,7 +104,7 @@ SmBusQuickWrite (
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r

-  @param  SmBusAddress  Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress  The address that encodes the SMBUS Slave Address,\r

                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r


@@ -149,7 +149,7 @@ SmBusReceiveByte (
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r

-  @param  SmBusAddress  Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress  The address that encodes the SMBUS Slave Address,\r

                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Value         The 8-bit value to send.\r
   @param  Status        Return status for the executed command.\r
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Value         The 8-bit value to send.\r
   @param  Status        Return status for the executed command.\r


@@ -196,7 +196,7 @@ SmBusSendByte (
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r

-  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress    The address that encodes the SMBUS Slave Address,\r

                           SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
                           SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r


@@ -240,7 +240,7 @@ SmBusReadDataByte (
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r

-  @param  SmBusAddress  Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress  The address that encodes the SMBUS Slave Address,\r

                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Value         The 8-bit value to write.\r
   @param  Status        Return status for the executed command.\r
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Value         The 8-bit value to write.\r
   @param  Status        Return status for the executed command.\r


@@ -286,7 +286,7 @@ SmBusWriteDataByte (
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
   \r
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
   \r

-  @param  SmBusAddress  Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress  The address that encodes the SMBUS Slave Address,\r

                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r


@@ -330,7 +330,7 @@ SmBusReadDataWord (
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r

-  @param  SmBusAddress  Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress  The address that encodes the SMBUS Slave Address,\r

                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Value         The 16-bit value to write.\r
   @param  Status        Return status for the executed command.\r
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Value         The 16-bit value to write.\r
   @param  Status        Return status for the executed command.\r


@@ -377,7 +377,7 @@ SmBusWriteDataWord (
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r
   If Length in SmBusAddress is not zero, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r

-  @param  SmBusAddress  Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress  The address that encodes the SMBUS Slave Address,\r

                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Value         The 16-bit value to write.\r
   @param  Status        Return status for the executed command.\r
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Value         The 16-bit value to write.\r
   @param  Status        Return status for the executed command.\r


@@ -424,9 +424,9 @@ SmBusProcessCall (
   If Buffer is NULL, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r
   If Buffer is NULL, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r

-  @param  SmBusAddress  Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress  The address that encodes the SMBUS Slave Address,\r

                         SMBUS Command, SMBUS Data Length, and PEC.\r
                         SMBUS Command, SMBUS Data Length, and PEC.\r

-  @param  Buffer        Pointer to the buffer to store the bytes read from the SMBUS.\r
+  @param  Buffer        The pointer to the buffer to store the bytes read from the SMBUS.\r

   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
                         RETURN_SUCCESS The SMBUS command was executed.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
                         RETURN_SUCCESS The SMBUS command was executed.\r


@@ -468,9 +468,9 @@ SmBusReadBlock (
   If Buffer is NULL, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r
   If Buffer is NULL, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r

-  @param  SmBusAddress  Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress  The address that encodes the SMBUS Slave Address,\r

                         MBUS Command, SMBUS Data Length, and PEC.\r
                         MBUS Command, SMBUS Data Length, and PEC.\r

-  @param  Buffer        Pointer to the buffer to store the bytes read from the SMBUS.\r
+  @param  Buffer        The pointer to the buffer to store the bytes read from the SMBUS.\r

   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
                         RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
                         RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r


@@ -517,10 +517,10 @@ SmBusWriteBlock (
   If ReadBuffer is NULL, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r
   If ReadBuffer is NULL, then ASSERT().\r
   If any reserved bits of SmBusAddress are set, then ASSERT().\r
 \r

-  @param  SmBusAddress  Address that encodes the SMBUS Slave Address,\r
+  @param  SmBusAddress  The address that encodes the SMBUS Slave Address,\r

                         SMBUS Command, SMBUS Data Length, and PEC.\r
                         SMBUS Command, SMBUS Data Length, and PEC.\r

-  @param  WriteBuffer   Pointer to the buffer of bytes to write to the SMBUS.\r
-  @param  ReadBuffer    Pointer to the buffer of bytes to read from the SMBUS.\r
+  @param  WriteBuffer   The pointer to the buffer of bytes to write to the SMBUS.\r
+  @param  ReadBuffer    The pointer to the buffer of bytes to read from the SMBUS.\r

   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
                         RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
                         RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r