Zephyr API Documentation 4.2.0-rc3
A Scalable Open Source RTOS
 4.2.0-rc3
shell_cmd_help Struct Reference

Shell structured help descriptor. More...

#include <zephyr/shell/shell.h>

Data Fields

const char * description
 Command description.
const char * usage
 Command usage string.

Detailed Description

Shell structured help descriptor.

This structure provides an organized way to specify command help as opposed to a free-form string. This helps make help messages more consistent and easier to read.

Field Documentation

◆ description

const char* shell_cmd_help::description

Command description.

◆ usage

const char* shell_cmd_help::usage

Command usage string.


The documentation for this struct was generated from the following file: