doc: fix spelling errors

Signed-off-by: Fathi Boudra <fathi.boudra@linaro.org>
This commit is contained in:
Fathi Boudra 2016-10-30 10:22:12 +02:00 committed by Jon Trulson
parent 2d1ce18838
commit 2bc8159230
10 changed files with 21 additions and 21 deletions

View File

@ -331,7 +331,7 @@ namespace upm {
* Set a general usage mode. This function can be used to * Set a general usage mode. This function can be used to
* configure the filters and oversampling for a particular use * configure the filters and oversampling for a particular use
* case. These setting are documented in the BMP280 datasheet. * case. These setting are documented in the BMP280 datasheet.
* The default mode set in the contructor is * The default mode set in the constructor is
* USAGE_MODE_INDOOR_NAV, the highest resolution mode. * USAGE_MODE_INDOOR_NAV, the highest resolution mode.
* *
* @param mode One of the USAGE_MODE_T values. * @param mode One of the USAGE_MODE_T values.

View File

@ -1127,7 +1127,7 @@ namespace upm {
void setSelfTest(bool sign, bool amp, SELFTTEST_AXIS_T axis); void setSelfTest(bool sign, bool amp, SELFTTEST_AXIS_T axis);
/** /**
* Return the Interrupt Enables 0 register. These resgisters * Return the Interrupt Enables 0 register. These registers
* allow you to enable various interrupt conditions. See the * allow you to enable various interrupt conditions. See the
* datasheet for details. * datasheet for details.
* *

View File

@ -961,7 +961,7 @@ namespace upm {
void fifoConfig(FIFO_MODE_T mode, FIFO_DATA_SEL_T axes); void fifoConfig(FIFO_MODE_T mode, FIFO_DATA_SEL_T axes);
/** /**
* Return the Interrupt Enables 0 register. These resgisters * Return the Interrupt Enables 0 register. These registers
* allow you to enable various interrupt conditions. See the * allow you to enable various interrupt conditions. See the
* datasheet for details. * datasheet for details.
* *

View File

@ -430,7 +430,7 @@ namespace upm {
OPERATION_MODE_T getOpmode(); OPERATION_MODE_T getOpmode();
/** /**
* Return the Interrupt Enables register. This resgister * Return the Interrupt Enables register. This register
* allows you to enable various interrupt conditions. See the * allows you to enable various interrupt conditions. See the
* datasheet for details. * datasheet for details.
* *
@ -476,7 +476,7 @@ namespace upm {
uint8_t getInterruptStatus(); uint8_t getInterruptStatus();
/** /**
* Set the repetion counter for the X and Y axes. This allows the * Set the repetition counter for the X and Y axes. This allows the
* device to average a number of measurements for a more stable * device to average a number of measurements for a more stable
* output. See the datasheet for details. * output. See the datasheet for details.
* *
@ -486,7 +486,7 @@ namespace upm {
void setRepetitionsXY(uint8_t reps); void setRepetitionsXY(uint8_t reps);
/** /**
* Set the repetion counter for the Z axis. This allows the * Set the repetition counter for the Z axis. This allows the
* device to average a number of measurements for a more stable * device to average a number of measurements for a more stable
* output. See the datasheet for details. * output. See the datasheet for details.
* *

View File

@ -108,7 +108,7 @@ namespace upm {
/** /**
* Start configuration with basic options. This must be called * Start configuration with basic options. This must be called
* prior to init(), after the OZW() contructor is called. * prior to init(), after the OZW() constructor is called.
* *
* @param configPath Set the location of the OpenZWave config * @param configPath Set the location of the OpenZWave config
* directory, default is /etc/openzwave * directory, default is /etc/openzwave

View File

@ -72,7 +72,7 @@ namespace upm {
/** /**
* Start configuration with basic options. This must be called * Start configuration with basic options. This must be called
* prior to init(), after the OZW() contructor is called. * prior to init(), after the OZW() constructor is called.
* *
* @param configPath Set the location of the OpenZWave config * @param configPath Set the location of the OpenZWave config
* directory, default is /etc/openzwave * directory, default is /etc/openzwave

View File

@ -48,7 +48,7 @@ namespace upm {
typedef std::list<OpenZWave::ValueID> valueList_t; typedef std::list<OpenZWave::ValueID> valueList_t;
/** /**
* zwNode contructor. * zwNode constructor.
* *
* @param homeId the homeId os the network controller * @param homeId the homeId os the network controller
* @param nodeId the node index * @param nodeId the node index

View File

@ -304,7 +304,7 @@ namespace upm {
private: private:
/** /**
* Enables the I2C register auto-increment. This needs to be enabled * Enables the I2C register auto-increment. This needs to be enabled
* for write/readWord() to work. The contructor enables this by * for write/readWord() to work. The constructor enables this by
* default. * default.
* *
* @param ai True to enable, false otherwise * @param ai True to enable, false otherwise

View File

@ -241,7 +241,7 @@ namespace upm {
/** /**
* configures the SAM (Secure Access Module) * configures the SAM (Secure Access Module)
* *
* @return true if successfully configured * @return true if successfuly configured
*/ */
bool SAMConfig(void); bool SAMConfig(void);
@ -421,8 +421,8 @@ namespace upm {
uint8_t dataLen); uint8_t dataLen);
/** /**
* return the ATQA (Answer to Request Acknowlege) value. This * return the ATQA (Answer to Request Acknowledge) value. This
* value is only valid after a successfull call to * value is only valid after a successful call to
* readPassiveTargetID() * readPassiveTargetID()
* *
* @return ATQA value * @return ATQA value
@ -430,8 +430,8 @@ namespace upm {
uint16_t getATQA() { return m_ATQA; }; uint16_t getATQA() { return m_ATQA; };
/** /**
* return the SAK (Select Acknowlege) value. This * return the SAK (Select Acknowledge) value. This
* value is only valid after a successfull call to * value is only valid after a successful call to
* readPassiveTargetID() * readPassiveTargetID()
* *
* @return SAK value * @return SAK value
@ -491,9 +491,9 @@ namespace upm {
uint8_t m_key[6]; // Mifare Classic key uint8_t m_key[6]; // Mifare Classic key
uint8_t m_inListedTag; // Tg number of inlisted tag. uint8_t m_inListedTag; // Tg number of inlisted tag.
uint16_t m_ATQA; // ATQA (Answer to Request Acknowlege - ISO14443) uint16_t m_ATQA; // ATQA (Answer to Request Acknowledge - ISO14443)
// for currently inlisted card // for currently inlisted card
uint8_t m_SAK; // SAK (Select Acknowlege) uint8_t m_SAK; // SAK (Select Acknowledge)
// for currently inlisted card // for currently inlisted card
// debugables // debugables

View File

@ -126,7 +126,7 @@ namespace upm {
* same as they were last set during the last RX_DONE event. * same as they were last set during the last RX_DONE event.
*/ */
typedef enum { typedef enum {
REVENT_DONE = 0, // operation completed successfully REVENT_DONE = 0, // operation completed successfuly
REVENT_EXEC, // runninsg something REVENT_EXEC, // runninsg something
REVENT_ERROR, // failed, crc error, sync timeout REVENT_ERROR, // failed, crc error, sync timeout
REVENT_TIMEOUT // timed out REVENT_TIMEOUT // timed out
@ -1807,8 +1807,8 @@ namespace upm {
/** /**
* Start a receive operation. The method will return when * Start a receive operation. The method will return when
* completed, either successfully, or in error (crc, or other * completed, either successfuly, or in error (crc, or other
* issue). If completed successfully, the returned buffer can be * issue). If completed successfuly, the returned buffer can be
* read via getRxBuffer() or getRxBufferStr(). In addition, * read via getRxBuffer() or getRxBufferStr(). In addition,
* values for RSSI and SNR (Lora only) can be retrieved. * values for RSSI and SNR (Lora only) can be retrieved.
* *
@ -2011,7 +2011,7 @@ namespace upm {
uint8_t lookupFSKBandWidth(uint32_t bw); uint8_t lookupFSKBandWidth(uint32_t bw);
// received data (on successfull completion) // received data (on successful completion)
volatile int m_rxRSSI; volatile int m_rxRSSI;
volatile int m_rxSNR; volatile int m_rxSNR;
volatile int m_rxLen; volatile int m_rxLen;