get_summary


Description:

[ Version ( since = "2.34" ) ]
public unowned string? get_summary ()

Gets the summary for this.

If no summary has been provided in the schema for this, returns null.

The summary is a short description of the purpose of the key; usually one short sentence. Summaries 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.

Parameters:

this

a SettingsSchemaKey

Returns:

the summary for this, or null