Commit 3c95ce6d authored by Marcus Shawcroft's avatar Marcus Shawcroft Committed by Anas Nashif
Browse files

i2c: Add doxygen markup for internal only definitions. 



Change-Id: I85110b70b6b964ddb96e64ffb8ac16522b2f58a6
Signed-off-by: default avatarMarcus Shawcroft <marcus.shawcroft@arm.com>
parent 5697e9e8

include/i2c.h

+4 −2
Original line number Diff line number Diff line
@@ -55,8 +55,9 @@ extern "C" { 
/** I2C Ultra Fast Speed */

#define I2C_SPEED_ULTRA			(0x5)



/** For internal use. */

/** @cond INTERNAL_HIDDEN */

#define I2C_SPEED_MASK			(0x7 << 1)	/* 3 bits */

/** @endcond  */



/** Use 10-bit addressing. */

#define I2C_ADDR_10_BITS		(1 << 0)
@@ -78,8 +79,9 @@ extern "C" { 
/** Read message from I2C bus. */

#define I2C_MSG_READ			(1 << 0)



/** For internal use. */

/** @cond INTERNAL_HIDDEN */

#define I2C_MSG_RW_MASK			(1 << 0)

/** @endcond  */



/** Send STOP after this message. */

#define I2C_MSG_STOP			(1 << 1)

CRA Git | Maintained and supported by SUSTech CRA and CCSE