libfossil
fcli_help_arg_t Struct Reference

Describes help text for an application flag. More...

#include "fossil-cli.h"

Data Fields

char const * brief
 Brief description text. More...
 
void(* callback )()
 If not 0 and (this->brief!=0) then this is called to render the help text. More...
 
char const * flagLong
 "Long" flag, with no leading dashes. More...
 
char const * flagShort
 "Short" flag, with no leading dashes. More...
 
char const * valType
 Brief description of value type, e.g. More...
 

Detailed Description

Describes help text for an application flag.

Definition at line 107 of file fossil-cli.h.

Field Documentation

char const* fcli_help_arg_t::brief

Brief description text.

Definition at line 125 of file fossil-cli.h.

void(* fcli_help_arg_t::callback) ()

If not 0 and (this->brief!=0) then this is called to render the help text.

It should simply render the text to f_out().

Definition at line 120 of file fossil-cli.h.

char const* fcli_help_arg_t::flagLong

"Long" flag, with no leading dashes.

Definition at line 111 of file fossil-cli.h.

char const* fcli_help_arg_t::flagShort

"Short" flag, with no leading dashes.

Definition at line 109 of file fossil-cli.h.

char const* fcli_help_arg_t::valType

Brief description of value type, e.g.

"int" or "string", or 0 if the flag is a boolean (has no value).

Definition at line 115 of file fossil-cli.h.


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