Docs update in platform folder

1. Remove protected member functions and protected attributes from rendering
   on docs site
2. Update BusInOut doxygen
pull/8670/head
Deepika 2018-11-07 13:23:06 -06:00
parent e635613b28
commit a21a4224c5
12 changed files with 35 additions and 16 deletions

View File

@ -106,6 +106,7 @@ public:
*/ */
DigitalIn &operator[](int index); DigitalIn &operator[](int index);
#if !defined(DOXYGEN_ONLY)
protected: protected:
DigitalIn *_pin[16]; DigitalIn *_pin[16];
@ -120,6 +121,7 @@ protected:
private: private:
virtual void lock(); virtual void lock();
virtual void unlock(); virtual void unlock();
#endif
}; };
} // namespace mbed } // namespace mbed

View File

@ -83,15 +83,15 @@ public:
*/ */
int read(); int read();
/** Set as an output /** Set all the pins in bus as output
*/ */
void output(); void output();
/** Set as an input /** Set all the pins in bus as an input
*/ */
void input(); void input();
/** Set the input pin mode /** Set the input pin mode for all the pins in bus
* *
* @param pull PullUp, PullDown, PullNone * @param pull PullUp, PullDown, PullNone
*/ */
@ -124,7 +124,7 @@ public:
* \sa BusInOut::read() * \sa BusInOut::read()
*/ */
operator int(); operator int();
#if !defined(DOXYGEN_ONLY)
protected: protected:
virtual void lock(); virtual void lock();
virtual void unlock(); virtual void unlock();
@ -137,6 +137,7 @@ protected:
int _nc_mask; int _nc_mask;
PlatformMutex _mutex; PlatformMutex _mutex;
#endif
}; };
} // namespace mbed } // namespace mbed

View File

@ -108,7 +108,7 @@ public:
* \sa BusOut::read() * \sa BusOut::read()
*/ */
operator int(); operator int();
#if !defined(DOXYGEN_ONLY)
protected: protected:
virtual void lock(); virtual void lock();
virtual void unlock(); virtual void unlock();
@ -121,6 +121,7 @@ protected:
int _nc_mask; int _nc_mask;
PlatformMutex _mutex; PlatformMutex _mutex;
#endif
}; };
} // namespace mbed } // namespace mbed

View File

@ -138,6 +138,7 @@ public:
*/ */
uint8_t get_erase_value() const; uint8_t get_erase_value() const;
#if !defined(DOXYGEN_ONLY)
private: private:
/* Check if address and size are aligned to a sector /* Check if address and size are aligned to a sector
@ -151,6 +152,7 @@ private:
flash_t _flash; flash_t _flash;
uint8_t *_page_buf; uint8_t *_page_buf;
static SingletonPtr<PlatformMutex> _mutex; static SingletonPtr<PlatformMutex> _mutex;
#endif
}; };
} /* namespace mbed */ } /* namespace mbed */

View File

@ -198,6 +198,7 @@ public:
*/ */
void abort_transfer(); void abort_transfer();
#if !defined(DOXYGEN_ONLY)
protected: protected:
/** Lock deep sleep only if it is not yet locked */ /** Lock deep sleep only if it is not yet locked */
void lock_deep_sleep(); void lock_deep_sleep();
@ -211,6 +212,7 @@ protected:
DMAUsage _usage; DMAUsage _usage;
bool _deep_sleep_locked; bool _deep_sleep_locked;
#endif #endif
#endif
#if !defined(DOXYGEN_ONLY) #if !defined(DOXYGEN_ONLY)
protected: protected:
@ -222,7 +224,6 @@ protected:
static SingletonPtr<PlatformMutex> _mutex; static SingletonPtr<PlatformMutex> _mutex;
PinName _sda; PinName _sda;
PinName _scl; PinName _scl;
#endif
private: private:
/** Recover I2C bus, when stuck with SDA low /** Recover I2C bus, when stuck with SDA low
@ -237,6 +238,7 @@ private:
* *
*/ */
int recover(PinName sda, PinName scl); int recover(PinName sda, PinName scl);
#endif
}; };
} // namespace mbed } // namespace mbed

View File

@ -166,6 +166,7 @@ public:
"public API of mbed-os and is being removed in the future.") "public API of mbed-os and is being removed in the future.")
bool remove_handler(pFunctionPointer_t handler, IRQn_Type irq); bool remove_handler(pFunctionPointer_t handler, IRQn_Type irq);
#if !defined(DOXYGEN_ONLY)
private: private:
InterruptManager(); InterruptManager();
~InterruptManager(); ~InterruptManager();
@ -198,6 +199,7 @@ private:
CallChain *_chains[NVIC_NUM_VECTORS]; CallChain *_chains[NVIC_NUM_VECTORS];
static InterruptManager *_instance; static InterruptManager *_instance;
PlatformMutex _mutex; PlatformMutex _mutex;
#endif
}; };
} // namespace mbed } // namespace mbed

View File

@ -33,12 +33,13 @@ namespace mbed {
* @ingroup drivers * @ingroup drivers
*/ */
class LowPowerTimeout : public LowPowerTicker, private NonCopyable<LowPowerTimeout> { class LowPowerTimeout : public LowPowerTicker, private NonCopyable<LowPowerTimeout> {
#if !defined(DOXYGEN_ONLY)
private: private:
virtual void handler(void) virtual void handler(void)
{ {
_function.call(); _function.call();
} }
#endif
}; };
} }

View File

@ -302,6 +302,7 @@ public:
return width; return width;
} }
#if !defined(DOXYGEN_ONLY)
private: private:
uint32_t _initial_value; uint32_t _initial_value;
uint32_t _final_xor; uint32_t _final_xor;
@ -546,6 +547,7 @@ private:
} }
_mode = (_crc_table != NULL) ? TABLE : BITWISE; _mode = (_crc_table != NULL) ? TABLE : BITWISE;
} }
#endif
}; };
#if defined ( __CC_ARM ) #if defined ( __CC_ARM )

View File

@ -208,6 +208,7 @@ public:
*/ */
int set_dma_usage(DMAUsage usage); int set_dma_usage(DMAUsage usage);
#if !defined(DOXYGEN_ONLY)
protected: protected:
/** SPI interrupt handler. /** SPI interrupt handler.
*/ */
@ -263,8 +264,6 @@ protected:
*/ */
void start_transfer(const void *tx_buffer, int tx_length, void *rx_buffer, int rx_length, unsigned char bit_width, const event_callback_t &callback, int event); void start_transfer(const void *tx_buffer, int tx_length, void *rx_buffer, int rx_length, unsigned char bit_width, const event_callback_t &callback, int event);
#if !defined(DOXYGEN_ONLY)
private: private:
/** Lock deep sleep only if it is not yet locked */ /** Lock deep sleep only if it is not yet locked */
void lock_deep_sleep(); void lock_deep_sleep();
@ -294,7 +293,6 @@ private:
#endif //DEVICE_SPI_ASYNCH #endif //DEVICE_SPI_ASYNCH
#if !defined(DOXYGEN_ONLY) #if !defined(DOXYGEN_ONLY)
protected: protected:
/* Internal SPI object identifying the resources */ /* Internal SPI object identifying the resources */
spi_t _spi; spi_t _spi;

View File

@ -141,6 +141,7 @@ public:
*/ */
void send_break(); void send_break();
#if !defined(DOXYGEN_ONLY)
protected: protected:
/** Acquire exclusive access to this serial port /** Acquire exclusive access to this serial port
@ -150,7 +151,7 @@ protected:
/** Release exclusive access to this serial port /** Release exclusive access to this serial port
*/ */
virtual void unlock(void); virtual void unlock(void);
#endif
public: public:
#if DEVICE_SERIAL_FC #if DEVICE_SERIAL_FC
@ -235,12 +236,15 @@ public:
*/ */
int set_dma_usage_rx(DMAUsage usage); int set_dma_usage_rx(DMAUsage usage);
#if !defined(DOXYGEN_ONLY)
protected: protected:
void start_read(void *buffer, int buffer_size, char buffer_width, const event_callback_t &callback, int event, unsigned char char_match); void start_read(void *buffer, int buffer_size, char buffer_width, const event_callback_t &callback, int event, unsigned char char_match);
void start_write(const void *buffer, int buffer_size, char buffer_width, const event_callback_t &callback, int event); void start_write(const void *buffer, int buffer_size, char buffer_width, const event_callback_t &callback, int event);
void interrupt_handler_asynch(void); void interrupt_handler_asynch(void);
#endif #endif
#endif
#if !defined(DOXYGEN_ONLY)
protected: protected:
SerialBase(PinName tx, PinName rx, int baud); SerialBase(PinName tx, PinName rx, int baud);
virtual ~SerialBase(); virtual ~SerialBase();
@ -259,7 +263,7 @@ protected:
serial_t _serial; serial_t _serial;
Callback<void()> _irq[IrqCnt]; Callback<void()> _irq[IrqCnt];
int _baud; int _baud;
#endif
}; };
} // namespace mbed } // namespace mbed

View File

@ -56,8 +56,10 @@ namespace mbed {
*/ */
class Timeout : public Ticker, private NonCopyable<Timeout> { class Timeout : public Ticker, private NonCopyable<Timeout> {
#if !defined(DOXYGEN_ONLY)
protected: protected:
virtual void handler(); virtual void handler();
#endif
}; };
} // namespace mbed } // namespace mbed

View File

@ -43,6 +43,7 @@ public:
*/ */
virtual ~TimerEvent(); virtual ~TimerEvent();
#if !defined(DOXYGEN_ONLY)
protected: protected:
// The handler called to service the timer event of the derived class // The handler called to service the timer event of the derived class
virtual void handler() = 0; virtual void handler() = 0;
@ -77,6 +78,7 @@ protected:
ticker_event_t event; ticker_event_t event;
const ticker_data_t *_ticker_data; const ticker_data_t *_ticker_data;
#endif
}; };
} // namespace mbed } // namespace mbed