Package: gio

Function gio:settings-schema-key-description

Lambda List

gio:settings-schema-key-description (key)

Arguments

key -- a g:settings-schema-key instance

Return Value

The string for the description of key.

Details

Gets the description for key. If no description has been provided in the schema for key, returns nil.

The description can be one sentence to several paragraphs in length. Paragraphs are delimited with a double newline. Descriptions can be translated and the value returned from this function is is the current locale.

This function is slow. The summary and description information for the schemas is not stored in the compiled schema database so this function has to parse all of the source XML files in the schema directory.
 

See also

2026-03-24