Fix typos in header file comments. (#159)

This commit is contained in:
Abtin Keshavarzian
2016-06-15 19:18:19 -07:00
committed by Jonathan Hui
parent 5933dbf62a
commit 8590a067e5
24 changed files with 50 additions and 50 deletions
+4 -4
View File
@@ -172,7 +172,7 @@ typedef struct otActiveScanResult
* @defgroup config-general General
*
* @brief
* This module includes functions that manage configuration parameters for the Thread Child, Router, and Leader rols.
* This module includes functions that manage configuration parameters for the Thread Child, Router, and Leader roles.
*
* @{
*
@@ -414,10 +414,10 @@ typedef struct otMacCounters
uint32_t mRxWhitelistFiltered; ///< The number of received packets filtered by whitelist.
uint32_t mRxDestAddrFiltered; ///< The number of received packets filtered by destination check.
uint32_t mRxErrNoFrame; ///< The number of received packets that do not contain contents.
uint32_t mRxErrUnknownNeighbor; ///< The number of recevied packets from unknown neighbor.
uint32_t mRxErrUnknownNeighbor; ///< The number of received packets from unknown neighbor.
uint32_t mRxErrInvalidSrcAddr; ///< The number of received packets whose source address is invalid.
uint32_t mRxErrSec; ///< The number of recevied packets with security error.
uint32_t mRxErrFcs; ///< The number of recevied packets with FCS error.
uint32_t mRxErrSec; ///< The number of received packets with security error.
uint32_t mRxErrFcs; ///< The number of received packets with FCS error.
uint32_t mRxErrOther; ///< The number of received packets with other error.
} otMacCounters;
+4 -4
View File
@@ -211,7 +211,7 @@ bool otActiveScanInProgress(void);
* @defgroup config-general General
*
* @brief
* This module includes functions that manage configuration parameters for the Thread Child, Router, and Leader rols.
* This module includes functions that manage configuration parameters for the Thread Child, Router, and Leader roles.
*
* @{
*
@@ -433,7 +433,7 @@ otShortAddress otGetShortAddress(void);
/**
* Get the list of IPv6 addresses assigned to the Thread interface.
*
* @returns A pointer to the first Network Inteface Address.
* @returns A pointer to the first Network Interface Address.
*/
const otNetifAddress *otGetUnicastAddresses(void);
@@ -1191,8 +1191,8 @@ otMessage otNewUdpMessage(void);
* @param[in] aCallback A pointer to the application callback function.
* @param[in] aContext A pointer to application-specific context.
*
* @retval kThreadErrorNone Successfully openned the socket.
* @retval kThreadErrorBusy Socket is already openned.
* @retval kThreadErrorNone Successfully opened the socket.
* @retval kThreadErrorBusy Socket is already opened.
*
* @sa otNewUdpMessage
* @sa otCloseUdpSocket
+1 -1
View File
@@ -71,7 +71,7 @@ enum
kPhyMinChannel = 11, ///< 2.4 GHz IEEE 802.15.4-2006
kPhyMaxChannel = 26, ///< 2.4 GHz IEEE 802.15.4-2006
kPhySymbolsPerOctet = 2, ///< 2.4 GHz IEEE 802.15.4-2006
kPhyBitRate = 250000, ///< 2.4 GHz IEEE 802.15.4 (kilbits per second)
kPhyBitRate = 250000, ///< 2.4 GHz IEEE 802.15.4 (kilobits per second)
kPhyBitsPerOctet = 8,
kPhyUsPerSymbol = ((kPhyBitsPerOctet / kPhySymbolsPerOctet) * 1000000) / kPhyBitRate,