From 78f8437c3bcc639a81454543006c683d81d1aa21 Mon Sep 17 00:00:00 2001 From: Sarah <91494325+sarah-iot@users.noreply.github.com> Date: Sat, 16 Jul 2022 18:41:13 -0700 Subject: [PATCH] [docs] update CLI comments (#7902) --- include/openthread/border_routing.h | 8 ++++---- include/openthread/instance.h | 2 +- src/cli/cli.cpp | 12 +++--------- 3 files changed, 8 insertions(+), 14 deletions(-) diff --git a/include/openthread/border_routing.h b/include/openthread/border_routing.h index 77199886f..f4c4d777b 100644 --- a/include/openthread/border_routing.h +++ b/include/openthread/border_routing.h @@ -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. diff --git a/include/openthread/instance.h b/include/openthread/instance.h index 2c3deb6d5..2ba2889e7 100644 --- a/include/openthread/instance.h +++ b/include/openthread/instance.h @@ -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 diff --git a/src/cli/cli.cpp b/src/cli/cli.cpp index 5ea92fdda..b90ed3764 100644 --- a/src/cli/cli.cpp +++ b/src/cli/cli.cpp @@ -586,21 +586,17 @@ template <> otError Interpreter::Process(Arg aArgs[]) } #endif // OPENTHREAD_CONFIG_BORDER_ROUTING_NAT64_ENABLE /** - * @cli br rioprf [high\med\low] - * + * @cli br rioprf (high,med,low) * @code * br rioprf * med * Done * @endcode - * - * @cparam br rioprf [@ca{high}|@ca{med}|@ca{low}] - * * @code * br rioprf low * Done * @endcode - * + * @cparam br rioprf [@ca{high}|@ca{med}|@ca{low}] * @par api_copy * #otBorderRoutingSetRouteInfoOptionPreference * @@ -621,16 +617,14 @@ template <> otError Interpreter::Process(Arg aArgs[]) } /** * @cli br prefixtable - * * @code - * > br prefixtable + * br prefixtable * prefix:fd00:1234:5678:0::/64, on-link:no, ms-since-rx:29526, lifetime:1800, route-prf:med, * router:ff02:0:0:0:0:0:0:1 * prefix:1200:abba:baba:0::/64, on-link:yes, ms-since-rx:29527, lifetime:1800, preferred:1800, * router:ff02:0:0:0:0:0:0:1 * Done * @endcode - * * @par api_copy * #otBorderRoutingGetNextPrefixTableEntry *