diff options
| author | Marcus Shawcroft <marcus.shawcroft@arm.com> | 2016-11-22 15:25:05 +0000 |
|---|---|---|
| committer | Anas Nashif <nashif@linux.intel.com> | 2016-11-22 17:01:27 +0000 |
| commit | 22f438b5ef1da2c86b6f9629d220ff49880d7390 (patch) | |
| tree | 4bf8e26095040e955dfbde3f9b211c6c143b2d8d /include/gpio.h | |
| parent | 1b3a933164e7391a2d7dc6ca5466620075471bf2 (diff) | |
gpio: Add doxygen markup for internal only definitions.
Change-Id: Ibc01d35199c643e186b58282af971975c0999e8b
Signed-off-by: Marcus Shawcroft <marcus.shawcroft@arm.com>
Diffstat (limited to 'include/gpio.h')
| -rw-r--r-- | include/gpio.h | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/include/gpio.h b/include/gpio.h index 752a046c0..c6ac071b7 100644 --- a/include/gpio.h +++ b/include/gpio.h @@ -50,8 +50,9 @@ extern "C" { /** GPIO pin to be output. */ #define GPIO_DIR_OUT (1 << 0) -/** For internal use. */ +/** @cond INTERNAL_HIDDEN */ #define GPIO_DIR_MASK 0x1 +/** @endcond */ /** GPIO pin to trigger interrupt. */ #define GPIO_INT (1 << 1) @@ -81,8 +82,9 @@ extern "C" { * GPIO_POL_* define the polarity of the GPIO (1 bit). */ -/** For internal use. */ +/** @cond INTERNAL_HIDDEN */ #define GPIO_POL_POS 7 +/** @endcond */ /** GPIO pin polarity is normal. */ #define GPIO_POL_NORMAL (0 << GPIO_POL_POS) @@ -90,15 +92,17 @@ extern "C" { /** GPIO pin polarity is inverted. */ #define GPIO_POL_INV (1 << GPIO_POL_POS) -/** For internal use. */ +/** @cond INTERNAL_HIDDEN */ #define GPIO_POL_MASK (1 << GPIO_POL_POS) +/** @endcond */ /* * GPIO_PUD_* are related to pull-up/pull-down. */ -/** For internal use. */ +/** @cond INTERNAL_HIDDEN */ #define GPIO_PUD_POS 8 +/** @endcond */ /** GPIO pin to have no pull-up or pull-down. */ #define GPIO_PUD_NORMAL (0 << GPIO_PUD_POS) @@ -109,8 +113,9 @@ extern "C" { /** Enable GPIO pin pull-down. */ #define GPIO_PUD_PULL_DOWN (2 << GPIO_PUD_POS) -/** For internal use. */ +/** @cond INTERNAL_HIDDEN */ #define GPIO_PUD_MASK (3 << GPIO_PUD_POS) +/** @endcond */ /* * GPIO_PIN_(EN-/DIS-)ABLE are for pin enable / disable. |