SettingsSchemaKey.getSummary

Gets the summary for key.

If no summary has been provided in the schema for key, 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.

class SettingsSchemaKey
string
getSummary
()

Return Value

Type: string

the summary for key, or NULL

Meta

Since

2.34