nl::ArgParser::HelpOptions

#include <src/lib/support/nlargparser.hpp>

OptionSet común para manejar opciones informativas (ayuda, versión)

Resumen

Herencia

Se hereda de: nl::ArgParser::OptionSetBase

Constructores y destructores
HelpOptions(const char *appName, const char *appUsage, const char *appVersion)
HelpOptions(const char *appName, const char *appUsage, const char *appVersion, const char *appDesc)

Atributos públicos
AppDesc
const char *
Es una descripción del propósito o comportamiento de la aplicación.
AppName
const char *
El nombre de la aplicación de línea de comandos.
AppUsage
const char *
Es una cadena corta que representa la sintaxis de la línea de comandos de la aplicación.
AppVersion
const char *

Funciones públicas
HandleOption(const char *progName, OptionSet *optSet, int id, const char *name, const char *arg)
virtual bool
PrintBriefUsage(FILE *s)
void
Imprime una descripción breve del uso del comando seguida de instrucciones sobre cómo obtener más ayuda.
PrintLongUsage(OptionSet *optSets[], FILE *s)
void
Imprime la información de uso completa, incluida la información sobre todas las opciones disponibles.
PrintVersion(FILE *s)
void

Atributos públicos

AppDesc

const char * AppDesc

Es una descripción del propósito o comportamiento de la aplicación.

AppName

const char * AppName

El nombre de la aplicación de línea de comandos.

AppUsage

const char * AppUsage

Es una cadena corta que representa la sintaxis de la línea de comandos de la aplicación.

AppVersion

const char * AppVersion

Funciones públicas

HandleOption

virtual bool HandleOption(
  const char *progName,
  OptionSet *optSet,
  int id,
  const char *name,
  const char *arg
)

HelpOptions

 HelpOptions(
  const char *appName,
  const char *appUsage,
  const char *appVersion
)

HelpOptions

 HelpOptions(
  const char *appName,
  const char *appUsage,
  const char *appVersion,
  const char *appDesc
)

PrintBriefUsage

void PrintBriefUsage(
  FILE *s
)

Imprime una descripción breve del uso del comando seguida de instrucciones sobre cómo obtener más ayuda.

PrintLongUsage

void PrintLongUsage(
  OptionSet *optSets[],
  FILE *s
)

Imprime la información de uso completa, incluida la información sobre todas las opciones disponibles.

PrintVersion

void PrintVersion(
  FILE *s
)