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

[docs] added Doxygen tags to 4 CLIs (#9352)

Browse Source
This commit is contained in:
jrhodie
2023-08-13 14:41:43 -07:00
committed by GitHub
parent 73daf43bbd
commit 68c05650ee
1 changed files with 42 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/cli/cli.cpp
+42
View File
@@ -237,10 +237,31 @@ template <> otError Interpreter::Process<Cmd("version")>(Arg aArgs[])
{
otError error = OT_ERROR_NONE;
/**
* @cli version
* @code
* version
* OPENTHREAD/gf4f2f04; Jul 1 2016 17:00:09
* Done
* @endcode
* @par api_copy
* #otGetVersionString
*/
if (aArgs[0].IsEmpty())
{
OutputLine("%s", otGetVersionString());
}
/**
* @cli version api
* @code
* version api
* 28
* Done
* @endcode
* @par
* Prints the API version number.
*/
else if (aArgs[0] == "api")
{
OutputLine("%u", OPENTHREAD_API_VERSION);
@@ -7214,6 +7235,16 @@ template <> otError Interpreter::Process<Cmd("uptime")>(Arg aArgs[])
{
otError error = OT_ERROR_NONE;
/**
* @cli uptime
* @code
* uptime
* 12:46:35.469
* Done
* @endcode
* @par api_copy
* #otInstanceGetUptimeAsString
*/
if (aArgs[0].IsEmpty())
{
char string[OT_UPTIME_STRING_SIZE];
@@ -7221,6 +7252,17 @@ template <> otError Interpreter::Process<Cmd("uptime")>(Arg aArgs[])
otInstanceGetUptimeAsString(GetInstancePtr(), string, sizeof(string));
OutputLine("%s", string);
}
/**
* @cli uptime ms
* @code
* uptime ms
* 426238
* Done
* @endcode
* @par api_copy
* #otInstanceGetUptime
*/
else if (aArgs[0] == "ms")
{
OutputUint64Line(otInstanceGetUptime(GetInstancePtr()));