Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / Library / SmbusLib.h

diff --git a/MdePkg/Include/Library/SmbusLib.h b/MdePkg/Include/Library/SmbusLib.h
index 6d214aaa8e6bf51f51af49e43519475d22b6b4cc..c59f0bb4cf334944f2febbe9f4fa10f3193be459 100644 (file)
--- a/MdePkg/Include/Library/SmbusLib.h
+++ b/MdePkg/Include/Library/SmbusLib.h
@@ -1,25 +1,23 @@
 /** @file\r
-       SMBUS Functions\r
+  SMBUS Functions\r
 \r
-       Copyright (c) 2006, 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
+  Copyright (c) 2006, 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
-\r
-       Module Name:    SmbusLib.h\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
 #ifndef __SMBUS_LIB__\r
 #define __SMBUS_LIB__\r
 \r
-//\r
-// PEC BIT is bit 22 in SMBUS address\r
-//\r
+///\r
+/// PEC BIT is bit 22 in SMBUS address\r
+///\r
 #define SMBUS_LIB_PEC_BIT   (1 << 22)\r
 \r
 /**\r
@@ -65,8 +63,7 @@ EFIAPI
 SmBusQuickRead (\r
   IN  UINTN                     SmBusAddress,\r
   OUT RETURN_STATUS             *Status       OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Executes an SMBUS quick write command.\r
@@ -90,8 +87,7 @@ EFIAPI
 SmBusQuickWrite (\r
   IN  UINTN                     SmBusAddress,\r
   OUT RETURN_STATUS             *Status       OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Executes an SMBUS receive byte command.\r
@@ -117,8 +113,7 @@ EFIAPI
 SmBusReceiveByte (\r
   IN  UINTN          SmBusAddress,\r
   OUT RETURN_STATUS  *Status        OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Executes an SMBUS send byte command.\r
@@ -146,8 +141,7 @@ SmBusSendByte (
   IN  UINTN          SmBusAddress,\r
   IN  UINT8          Value,\r
   OUT RETURN_STATUS  *Status        OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Executes an SMBUS read data byte command.\r
@@ -172,8 +166,7 @@ EFIAPI
 SmBusReadDataByte (\r
   IN  UINTN          SmBusAddress,\r
   OUT RETURN_STATUS  *Status        OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Executes an SMBUS write data byte command.\r
@@ -201,8 +194,7 @@ SmBusWriteDataByte (
   IN  UINTN          SmBusAddress,\r
   IN  UINT8          Value,\r
   OUT RETURN_STATUS  *Status        OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Executes an SMBUS read data word command.\r
@@ -227,8 +219,7 @@ EFIAPI
 SmBusReadDataWord (\r
   IN  UINTN          SmBusAddress,\r
   OUT RETURN_STATUS  *Status        OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Executes an SMBUS write data word command.\r
@@ -256,8 +247,7 @@ SmBusWriteDataWord (
   IN  UINTN          SmBusAddress,\r
   IN  UINT16         Value,\r
   OUT RETURN_STATUS  *Status        OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Executes an SMBUS process call command.\r
@@ -285,8 +275,7 @@ SmBusProcessCall (
   IN  UINTN          SmBusAddress,\r
   IN  UINT16         Value,\r
   OUT RETURN_STATUS  *Status        OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Executes an SMBUS read block command.\r
@@ -317,8 +306,7 @@ SmBusReadBlock (
   IN  UINTN          SmBusAddress,\r
   OUT VOID           *Buffer,\r
   OUT RETURN_STATUS  *Status        OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Executes an SMBUS write block command.\r
@@ -347,8 +335,7 @@ SmBusWriteBlock (
   IN  UINTN          SmBusAddress,\r
   OUT VOID           *Buffer,\r
   OUT RETURN_STATUS  *Status        OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Executes an SMBUS block process call command.\r
@@ -381,8 +368,7 @@ SmBusBlockProcessCall (
   IN  VOID           *WriteBuffer,\r
   OUT VOID           *ReadBuffer,\r
   OUT RETURN_STATUS  *Status        OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 \r
 #endif\r