setSummary

fun setSummary(summary: String? = null)

Adds a string to be displayed in --help output before the list of options. This is typically a summary of the program functionality.

Note that the summary is translated (see g_option_context_set_translate_func() and g_option_context_set_translation_domain()).

Since

2.12

Parameters

summary

a string to be shown in --help output before the list of options, or null