espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-09-01 14:59:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change comments (fix typos) (#1343)

Browse Source
This commit is contained in:
Abtin Keshavarzian
2017-02-19 23:33:13 -08:00
committed by Jonathan Hui
parent d5f1287ead
commit 61c277ccac
8 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/commissioning/commissioner.h
+1 -1
View File
@@ -213,7 +213,7 @@ OTAPI ThreadError OTCALL otSendMgmtCommissionerSet(otInstance *, const otCommiss
const uint8_t *aTlvs, uint8_t aLength);
/**
* This function returns the origian Commissioner Session ID.
* This function returns the Commissioner Session ID.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
include/openthread-coap.h
+1 -1
View File
@@ -327,7 +327,7 @@ otMessage otCoapNewMessage(otInstance *aInstance, const otCoapHeader *aHeader);
/**
* This function sends a CoAP request.
*
* If a response for a request is expected, respective function and contex information should be provided.
* If a response for a request is expected, respective function and context information should be provided.
* If no response is expected, these arguments should be NULL pointers.
*
* @param[in] aInstance A pointer to an OpenThread instance.
include/openthread-types.h
+1 -1
View File
@@ -270,7 +270,7 @@ typedef struct otSecurityPolicy
} otSecurityPolicy;
/**
* This enumeration represents flags that indicate security related behaviours within OpenThread.
* This enumeration defines the Security Policy TLV flags.
*
*/
enum
src/core/mac/mac.hpp
+12 -12
View File
@@ -222,7 +222,7 @@ public:
typedef void (*EnergyScanHandler)(void *aContext, otEnergyScanResult *aResult);
/**
* This function starts an IEEE 802.15.4 Energy Scan.
* This method starts an IEEE 802.15.4 Energy Scan.
*
* @param[in] aScanChannels A bit vector indicating on which channels to perform energy scan.
* @param[in] aScanDuration The time in milliseconds to spend scanning each channel.
@@ -236,7 +236,7 @@ public:
ThreadError EnergyScan(uint32_t aScanChannels, uint16_t aScanDuration, EnergyScanHandler aHandler, void *aContext);
/**
* This function indicates the energy scan for the current channel is complete.
* This method indicates the energy scan for the current channel is complete.
*
* @param[in] aEnergyScanMaxRssi The maximum RSSI encountered on the scanned channel.
*
@@ -465,7 +465,7 @@ public:
bool IsEnergyScanInProgress(void);
/**
* This function registers a callback to provide received raw IEEE 802.15.4 frames.
* This method registers a callback to provide received raw IEEE 802.15.4 frames.
*
* @param[in] aPcapCallback A pointer to a function that is called when receiving an IEEE 802.15.4 link frame or
* NULL to disable the callback.
@@ -475,7 +475,7 @@ public:
void SetPcapCallback(otLinkPcapCallback aPcapCallback, void *aCallbackContext);
/**
* This function indicates whether or not promiscuous mode is enabled at the link layer.
* This method indicates whether or not promiscuous mode is enabled at the link layer.
*
* @retval true Promiscuous mode is enabled.
* @retval false Promiscuous mode is not enabled.
@@ -484,7 +484,7 @@ public:
bool IsPromiscuous(void);
/**
* This function enables or disables the link layer promiscuous mode.
* This method enables or disables the link layer promiscuous mode.
*
* Promiscuous mode keeps the receiver enabled, overriding the value of mRxOnWhenIdle.
*
@@ -494,7 +494,7 @@ public:
void SetPromiscuous(bool aPromiscuous);
/**
* This function fills network diagnostic MacCounterTlv.
* This method fills network diagnostic MacCounterTlv.
*
* @param[in] aMacCountersTlv The reference to the network diagnostic MacCounterTlv.
*
@@ -502,7 +502,7 @@ public:
void FillMacCountersTlv(NetworkDiagnostic::MacCountersTlv &aMacCounters) const;
/**
* This function resets mac counters
* This method resets mac counters
*
*/
void ResetCounters(void);
@@ -524,7 +524,7 @@ public:
LinkQualityInfo &GetNoiseFloor(void) { return mNoiseFloor; }
/**
* This function enable/disable source match.
* This method enables/disables source match feature.
*
* @param[in] aEnable Enable/disable source match for automatical pending.
*
@@ -532,7 +532,7 @@ public:
void EnableSrcMatch(bool aEnable);
/**
* This function adds the address into the source match table.
* This method adds the address into the source match table.
*
* @param[in] aAddr The address to be added into the source match table.
*
@@ -543,7 +543,7 @@ public:
ThreadError AddSrcMatchEntry(Address &aAddr);
/**
* This function removes the address from the source match table.
* This method removes the address from the source match table.
*
* @param[in] aAddr The address to be removed from the source match table.
*
@@ -554,13 +554,13 @@ public:
ThreadError ClearSrcMatchEntry(Address &aAddr);
/**
* This function emptys the source match table.
* This method clears the source match table.
*
*/
void ClearSrcMatchEntries(void);
/**
* This function indicates whether or not transmit retries and CSMA backoff logic is supported by the radio layer.
* This method indicates whether or not transmit retries and CSMA backoff logic is supported by the radio layer.
*
* @retval true Retries and CSMA are supported by the radio.
* @retval false Retries and CSMA are not supported by the radio.
src/core/meshcop/commissioner.hpp
+1 -1
View File
@@ -111,7 +111,7 @@ public:
ThreadError RemoveJoiner(const Mac::ExtAddress *aExtAddress);
/**
* This function sets the Provisioning URL.
* This method sets the Provisioning URL.
*
* @param[in] aProvisioningUrl A pointer to the Provisioning URL (may be NULL).
*
src/core/net/dhcp6_client.hpp
+1 -1
View File
@@ -179,7 +179,7 @@ public:
explicit Dhcp6Client(ThreadNetif &aThreadNetif);
/**
* This function update addresses that shall be automatically created using DHCP.
* This method update addresses that shall be automatically created using DHCP.
*
* @param[in] aInstance A pointer to openThread instance.
* @param[inout] aAddresses A pointer to an array containing addresses created by this module.
src/core/thread/link_quality.hpp
+2 -2
View File
@@ -228,7 +228,7 @@ private:
int8_t GetAverageNoiseFloor(LinkQualityInfo &aNoiseFloor);
/**
* This method adds a new noise floor value (in dBm) to the running average.
* This function adds a new noise floor value (in dBm) to the running average.
*
* @param[in] aNoiseFloor A reference to the noise state.
* @param[in] aNoise A new noise floor value (in dBm) to be added to the average.
@@ -237,7 +237,7 @@ int8_t GetAverageNoiseFloor(LinkQualityInfo &aNoiseFloor);
void AddNoiseFloor(LinkQualityInfo &aNoiseFloor, int8_t aNoise);
/**
* This method clears the current average noise floor value.
* This function clears the current average noise floor value.
*
* @param[in] aNoiseFloor A reference to the noise state.
*
src/core/utils/slaac_address.hpp
+3 -3
View File
@@ -102,7 +102,7 @@ class SemanticallyOpaqueIidGenerator: public otSemanticallyOpaqueIidGeneratorDat
{
public:
/**
* This function creates semantically opaque IID for given IPv6 address and context.
* This method creates semantically opaque IID for given IPv6 address and context.
*
* The generator starts with DAD counter provided as a class member field. The DAD counter is automatically
* incremented at most kMaxRetries times if creation of valid IPv6 address fails.
@@ -124,7 +124,7 @@ private:
};
/**
* This function creates semantically opaque IID for given arguments.
* This method creates semantically opaque IID for given arguments.
*
* This function creates IID only for given DAD counter value.
*
@@ -139,7 +139,7 @@ private:
ThreadError CreateIidOnce(otInstance *aInstance, otNetifAddress *aAddress);
/**
* This function checks if created IPv6 address is already registered in the Thread interface.
* This method checks if created IPv6 address is already registered in the Thread interface.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCreatedAddress A pointer to created IPv6 address.