espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-10-02 13:57:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] update CLI comments (#7902)

Browse Source
This commit is contained in:
Sarah
2022-07-16 18:41:13 -07:00
committed by GitHub
parent 793483da0d
commit 78f8437c3b
3 changed files with 8 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/border_routing.h
+4 -4
View File
@@ -152,11 +152,11 @@ otError otBorderRoutingSetEnabled(otInstance *aInstance, bool aEnabled);
otRoutePreference otBorderRoutingGetRouteInfoOptionPreference(otInstance *aInstance);
/**
* This function sets the preference to use when advertising Route Info Options (e.g., for discovered OMR prefixes) in
* Router Advertisement messages sent over the infrastructure link.
* This function sets the preference to use when advertising Route Info Options in Router Advertisement messages sent
* over the infrastructure link, for example for discovered OMR prefixes.
*
* By default BR will use 'medium' preference level but this function allows the default value to be changed. As an
* example, it can be set to 'low' preference in the case where device is a temporary BR (a mobile BR or a
* By default BR will use `medium` preference level, but this function allows the default value to be changed. As an
* example, it can be set to `low` preference in the case where device is a temporary BR (a mobile BR or a
* battery-powered BR) to indicate that other BRs (if any) should be preferred over this BR on the infrastructure link.
*
* @param[in] aInstance A pointer to an OpenThread instance.
include/openthread/instance.h
+1 -1
View File
@@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (227)
#define OPENTHREAD_API_VERSION (228)
/**
* @addtogroup api-instance