Issue #2120459 by amitsedaiz, mahesh.gupta, Yago Elias, jhodgdon, joachim: theme_status_report() doesn't document its parameters

merge-requests/26/head
David Rothstein 2017-10-04 17:55:39 -04:00
parent caf31116e9
commit 09f11419b5
1 changed files with 13 additions and 1 deletions

View File

@ -2565,9 +2565,21 @@ function theme_system_admin_index($variables) {
/**
* Returns HTML for the status report.
*
* This theme function is dependent on install.inc being loaded, because
* that's where the constants are defined.
*
* @param $variables
* An associative array containing:
* - requirements: An array of requirements.
* - requirements: An array of requirements/status items. Each requirement
* is an associative array containing the following elements:
* - title: The name of the requirement.
* - value: (optional) The current value (version, time, level, etc).
* - description: (optional) The description of the requirement.
* - severity: (optional) The requirement's result/severity level, one of:
* - REQUIREMENT_INFO: Status information.
* - REQUIREMENT_OK: The requirement is satisfied.
* - REQUIREMENT_WARNING: The requirement failed with a warning.
* - REQUIREMENT_ERROR: The requirement failed with an error.
*
* @ingroup themeable
*/