WallShell
An easy-to-use, highly portable, CLI using C99.
ws_help_entry_specific_t Struct Reference

Specific help structure. More...

Data Fields

const char * commandName
 Name of the command.
 
const char * description
 Description of the command.
 
const char ** required
 Flags/subcommands that are a required when running this command.
 
const int required_count
 Amount of flags/subcommands in the required part of this structure. More...
 
const char ** optional
 Flags/subcommands that are optional when running this command.
 
const int optional_count
 Amount of flags/subcommands in the optional part of this structure. More...
 

Detailed Description

Specific help structure.

Makes printing help menu entries consistent across different functions. Not all fields have to be filled in. You can leave fields as NULL to not print them.

This is meant for things like subcommands, flags, etc.

Meant to be used with ws_printSpecificHelp().

Field Documentation

◆ optional_count

optional_count

Amount of flags/subcommands in the optional part of this structure.

It's the count, not the indexes.

◆ required_count

required_count

Amount of flags/subcommands in the required part of this structure.

It's the count, not the indexes.


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