Skip to content

Commit 26b9a1f

Browse files
committed
Enable doxygen to use the pre-processor
Best way to enable MBED_DEPRICATED APIs to be properly rendered requires using the doxygen preprocessor. This means all device_has labels need to also be defined or the default DOXYGEN_ONLY label applied to the API headers which this commit does. ASYNCH currently exluded.
1 parent cba75f4 commit 26b9a1f

20 files changed

+20
-20
lines changed

drivers/AnalogIn.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_ANALOGIN
21+
#if defined (DEVICE_ANALOGIN) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/analogin_api.h"
2424
#include "platform/SingletonPtr.h"

drivers/AnalogOut.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_ANALOGOUT
21+
#if defined (DEVICE_ANALOGOUT) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/analogout_api.h"
2424
#include "platform/PlatformMutex.h"

drivers/CAN.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_CAN
21+
#if defined (DEVICE_CAN) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/can_api.h"
2424
#include "platform/Callback.h"

drivers/Ethernet.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_ETHERNET
21+
#if defined (DEVICE_ETHERNET) || defined(DOXYGEN_ONLY)
2222

2323
namespace mbed {
2424
/** \addtogroup drivers */

drivers/FlashIAP.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
#ifndef MBED_FLASHIAP_H
2323
#define MBED_FLASHIAP_H
2424

25-
#ifdef DEVICE_FLASH
25+
#if defined (DEVICE_FLASH) || defined(DOXYGEN_ONLY)
2626

2727
#include "flash_api.h"
2828
#include "platform/SingletonPtr.h"

drivers/I2C.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_I2C
21+
#if defined (DEVICE_I2C) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/i2c_api.h"
2424
#include "platform/SingletonPtr.h"

drivers/I2CSlave.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_I2CSLAVE
21+
#if defined (DEVICE_I2CSLAVE) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/i2c_api.h"
2424

drivers/InterruptIn.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_INTERRUPTIN
21+
#if defined (DEVICE_INTERRUPTIN) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/gpio_api.h"
2424
#include "hal/gpio_irq_api.h"

drivers/LowPowerTicker.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
#include "platform/platform.h"
2020
#include "drivers/Ticker.h"
2121

22-
#if DEVICE_LOWPOWERTIMER
22+
#if defined (DEVICE_LOWPOWERTIMER) || defined(DOXYGEN_ONLY)
2323

2424
#include "hal/lp_ticker_api.h"
2525

drivers/LowPowerTimeout.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_LOWPOWERTIMER
21+
#if defined (DEVICE_LOWPOWERTIMER) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/lp_ticker_api.h"
2424
#include "drivers/LowPowerTicker.h"

drivers/LowPowerTimer.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
#include "platform/platform.h"
2020
#include "drivers/Timer.h"
2121

22-
#if DEVICE_LOWPOWERTIMER
22+
#if defined (DEVICE_LOWPOWERTIMER) || defined(DOXYGEN_ONLY)
2323

2424
#include "hal/lp_ticker_api.h"
2525

drivers/PortIn.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_PORTIN
21+
#if defined (DEVICE_PORTIN) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/port_api.h"
2424
#include "platform/mbed_critical.h"

drivers/PortInOut.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_PORTINOUT
21+
#if defined (DEVICE_PORTINOUT) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/port_api.h"
2424
#include "platform/mbed_critical.h"

drivers/PortOut.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_PORTOUT
21+
#if defined (DEVICE_PORTOUT) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/port_api.h"
2424
#include "platform/mbed_critical.h"

drivers/PwmOut.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_PWMOUT
21+
#if defined (DEVICE_PWMOUT) || defined(DOXYGEN_ONLY)
2222
#include "hal/pwmout_api.h"
2323
#include "platform/mbed_critical.h"
2424

drivers/RawSerial.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_SERIAL
21+
#if defined (DEVICE_SERIAL) || defined(DOXYGEN_ONLY)
2222

2323
#include "drivers/SerialBase.h"
2424
#include "hal/serial_api.h"

drivers/SPI.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_SPI
21+
#if defined (DEVICE_SPI) || defined(DOXYGEN_ONLY)
2222

2323
#include "platform/PlatformMutex.h"
2424
#include "hal/spi_api.h"

drivers/SPISlave.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_SPISLAVE
21+
#if defined (DEVICE_SPISLAVE) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/spi_api.h"
2424

drivers/Serial.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_SERIAL
21+
#if defined (DEVICE_SERIAL) || defined(DOXYGEN_ONLY)
2222

2323
#include "Stream.h"
2424
#include "SerialBase.h"

drivers/SerialBase.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_SERIAL
21+
#if defined (DEVICE_SERIAL) || defined(DOXYGEN_ONLY)
2222

2323
#include "Stream.h"
2424
#include "Callback.h"

0 commit comments

Comments
 (0)