Merge branch 'doxy_fix_protected' of ssh://github.com/deepikabhavnani/mbed-os into rollup

pull/8694/head
Cruz Monrreal II 2018-11-09 11:40:31 -06:00
commit f7087b33e7
12 changed files with 35 additions and 16 deletions

View File

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

View File

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

View File

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

View File

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

View File

@ -108,7 +108,7 @@ public:
* @param data Pointer to the byte-array to read data in to
* @param length Number of bytes to read
* @param repeated Repeated start, true - don't send stop at end
* default value is false.
* default value is false.
*
* @returns
* 0 on success (ack),
@ -134,7 +134,7 @@ public:
* @param data Pointer to the byte-array data to send
* @param length Number of bytes to send
* @param repeated Repeated start, true - do not send stop at end
* default value is false.
* default value is false.
*
* @returns
* 0 on success (ack),
@ -188,8 +188,8 @@ public:
* @param event The logical OR of events to modify
* @param callback The event callback function
* @param repeated Repeated start, true - do not send stop at end
* default value is false.
*
* default value is false.
*
* @returns Zero if the transfer has started, or -1 if I2C peripheral is busy
*/
int transfer(int address, const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length, const event_callback_t &callback, int event = I2C_EVENT_TRANSFER_COMPLETE, bool repeated = false);
@ -198,6 +198,7 @@ public:
*/
void abort_transfer();
#if !defined(DOXYGEN_ONLY)
protected:
/** Lock deep sleep only if it is not yet locked */
void lock_deep_sleep();
@ -211,6 +212,7 @@ protected:
DMAUsage _usage;
bool _deep_sleep_locked;
#endif
#endif
#if !defined(DOXYGEN_ONLY)
protected:
@ -222,7 +224,6 @@ protected:
static SingletonPtr<PlatformMutex> _mutex;
PinName _sda;
PinName _scl;
#endif
private:
/** Recover I2C bus, when stuck with SDA low
@ -237,6 +238,7 @@ private:
*
*/
int recover(PinName sda, PinName scl);
#endif
};
} // namespace mbed

View File

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

View File

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

View File

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

View File

@ -208,6 +208,7 @@ public:
*/
int set_dma_usage(DMAUsage usage);
#if !defined(DOXYGEN_ONLY)
protected:
/** 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);
#if !defined(DOXYGEN_ONLY)
private:
/** Lock deep sleep only if it is not yet locked */
void lock_deep_sleep();
@ -294,7 +293,6 @@ private:
#endif //DEVICE_SPI_ASYNCH
#if !defined(DOXYGEN_ONLY)
protected:
/* Internal SPI object identifying the resources */
spi_t _spi;

View File

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

View File

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

View File

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