diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc index 4566a5e..cc542ca 100644 --- a/core/includes/bootstrap.inc +++ b/core/includes/bootstrap.inc @@ -1,5 +1,10 @@ '. A few notes: * - If you provide a full URL, it will be considered an external URL. - * - If you provide only the path (e.g. "node/34"), it will be + * - If you provide only the path (e.g., "node/34"), it will be * considered an internal link. In this case, it should be a system URL, * and it will be replaced with the alias, if one exists. Additional query * arguments for internal paths must be supplied in $options['query'], not @@ -2123,7 +2123,7 @@ function _format_date_callback(array $matches = NULL, $new_langcode = NULL) { * path is assumed already to be the correct path alias, and the alias is * not looked up. * - The special string '' generates a link to the site's base URL. - * - If your external URL contains a query (e.g. http://example.com/foo?a=b), + * - If your external URL contains a query (e.g., http://example.com/foo?a=b), * then you can either URL encode the query keys and values yourself and * include them in $path, or use $options['query'] to let this function * URL encode them. @@ -2259,7 +2259,7 @@ function url($path = NULL, array $options = array()) { } /** - * Returns TRUE if a path is external to Drupal (e.g. http://example.com). + * Returns TRUE if a path is external to Drupal (e.g., http://example.com). * * If a path cannot be assessed by Drupal's menu handler, then we must * treat it as potentially insecure. @@ -3314,7 +3314,7 @@ function drupal_build_css_cache($css) { * information. * @param string|null $base * (optional) The base path for the CSS files. Cached statically. This - * parameter is not used if $matches is passed. + * parameter is not used if $matches is passed. Defaults to NULL. * * @return string * A prefixed path as a string. @@ -4721,17 +4721,19 @@ function drupal_get_library($module, $name = NULL) { * A class name applied on all related form elements for this action. * @param $subgroup * (optional) If the group has several subgroups within it, this string should - * contain the class name identifying fields in the same subgroup. + * contain the class name identifying fields in the same subgroup. Defaults to + * NULL. * @param $source * (optional) If the $action is 'match', this string should contain the class * name identifying what field will be used as the source value when matching - * the value in $subgroup. + * the value in $subgroup. Defaults to NULL. * @param $hidden * (optional) The column containing the field elements may be entirely hidden * from view dynamically when the JavaScript is loaded. Set to FALSE if the - * column should not be hidden. + * column should not be hidden. Defaults to TRUE. * @param $limit - * (optional) Limit the maximum amount of parenting in this table. + * (optional) Limit the maximum amount of parenting in this table. Defaults to + * zero. * * @see block-admin-display-form.tpl.php * @see theme_menu_overview_form() @@ -5075,8 +5077,8 @@ function drupal_page_set_cache($body) { * * Do not call this function from a test. Use $this->cronRun() instead. * - * @return - * TRUE if cron ran successfully. + * @return bool + * TRUE if cron ran successfully, FALSE if a lock could not be acquired. */ function drupal_cron_run() { // Allow execution to continue even if the request gets canceled. @@ -5648,7 +5650,7 @@ function drupal_render_page($page) { * #theme is the theme function called first. If it is set and the element has * any children, it is the responsibility of the theme function to render * these children. For elements that are not allowed to have any children, - * e.g. buttons or textfields, the theme function can be used to render the + * e.g., buttons or textfields, the theme function can be used to render the * element itself. If #theme is not present and the element has children, each * child is itself rendered by a call to drupal_render(), and the results are * concatenated. @@ -6807,10 +6809,10 @@ function watchdog_severity_levels() { * * @param string $tags. * A comma-separated string of values (tags, etc.), with any value - * containing a comma wrapped in double quotes (e.g. "Madison, WI"). + * containing a comma wrapped in double quotes (e.g., "Madison, WI"). * * @return array - * An emty array or an array of strings. + * An empty array or an array of strings. * * @see drupal_implode_tags() */ @@ -7016,7 +7018,7 @@ function debug($data, $label = NULL, $print_r = FALSE) { * * @return * An associative array with three keys: - * - 'name' includes the name of the thing to depend on (e.g. 'foo'). + * - 'name' includes the name of the thing to depend on (e.g., 'foo'). * - 'original_version' contains the original version string (which can be * used in the UI for reporting incompatibilities). * - 'versions' is a list of associative arrays, each containing the keys