SettingsSchemaKey.getDescription

Gets the description for @key.

If no description has been provided in the schema for @key, returns %NULL.

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.

class SettingsSchemaKey
string
getDescription
()

Return Value

Type: string

the description for @key, or %NULL

Meta

Since

2.34