Method

FoundryCliCommandTreeregister_group

unstable since: 1.2

Declaration [src]

void
foundry_cli_command_tree_register_group (
  FoundryCliCommandTree* self,
  const char* const* path,
  const char* gettext_package,
  const char* summary
)

Description [src]

Adds help metadata to a command group. The group may be registered before or after its child commands and may also have a command of its own.

Available since: 1.2

Parameters

path

Type: An array of char*

The command group path.

The array must be NULL-terminated.
The data is owned by the caller of the method.
Each element is a NUL terminated UTF-8 string.
gettext_package

Type: const char*

Gettext package for summary.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
summary

Type: const char*

A short summary of the command group.

The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.