diff --git a/core/includes/install.inc b/core/includes/install.inc index 72adf1c..2d7c663 100644 --- a/core/includes/install.inc +++ b/core/includes/install.inc @@ -4,6 +4,11 @@ use Drupal\Core\Database\Database; use Drupal\Core\Config\SignedFileStorage; /** + * @file + * API functions for installing modules and themes. + */ + +/** * Indicates that a module has not been installed yet. */ const SCHEMA_UNINSTALLED = -1; @@ -114,6 +119,7 @@ function drupal_install_profile_distribution_name() { * @param $file * The name of the file calling this function so we can strip it out of * the URI when generating the base_url. + * * @return * The auto-detected $base_url that should be configured in settings.php */ @@ -265,6 +271,7 @@ function drupal_rewrite_settings($settings = array()) { * * @param $install_state * An array of information about the current installation state. + * * @return * The list of modules to install. */ @@ -431,6 +438,7 @@ function drupal_uninstall_modules($module_list = array(), $uninstall_dependents * An optional bitmask created from various FILE_* constants. * @param $type * The type of file. Can be file (default), dir, or link. + * * @return * TRUE on success or FALSE on failure. A message is set for the latter. */ @@ -510,6 +518,7 @@ function drupal_verify_install_file($file, $mask = NULL, $type = 'file') { * The permissions of the directory to create. * @param $message * (optional) Whether to output messages. Defaults to TRUE. + * * @return * TRUE/FALSE whether or not the directory was successfully created. */ @@ -558,6 +567,7 @@ function drupal_install_mkdir($file, $mask, $message = TRUE) { * The desired permissions for the file. * @param $message * (optional) Whether to output messages. Defaults to TRUE. + * * @return * TRUE/FALSE whether or not we were able to fix the file's permissions. */ @@ -765,6 +775,7 @@ function st($string, array $args = array(), array $options = array()) { * * @param $profile * Name of install profile to check. + * * @return * Array of the install profile's requirements. */ @@ -797,6 +808,7 @@ function drupal_check_profile($profile) { * @param $requirements * An array of requirements, in the same format as is returned by * hook_requirements(). + * * @return * The highest severity in the array. */ @@ -815,6 +827,7 @@ function drupal_requirements_severity(&$requirements) { * * @param $module * Machine name of module to check. + * * @return * TRUE/FALSE depending on the requirements are in place. */ diff --git a/core/includes/menu.inc b/core/includes/menu.inc index fecd158..520e6e6 100644 --- a/core/includes/menu.inc +++ b/core/includes/menu.inc @@ -2094,8 +2094,6 @@ function menu_local_tasks($level = 0) { * local tasks for a given system path. All local tasks of the tab type * MENU_CONTEXT_INLINE are taken into account. * - * @see hook_menu() - * * For example, when considering the following registered local tasks: * - node/%node/view (default local task) with no 'context' defined * - node/%node/edit with context: MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE @@ -2123,6 +2121,7 @@ function menu_local_tasks($level = 0) { * A list of menu router items that are local tasks for the passed-in path. * * @see contextual_links_preprocess() + * @see hook_menu() */ function menu_contextual_links($module, $parent_path, $args) { static $path_empty = array(); @@ -3177,6 +3176,7 @@ function menu_link_save(&$item, $existing_item = array(), $parent_candidates = a * A menu link. * @param $parent_candidates * An array of menu links keyed by mlid. + * * @return * A menu link structure of the possible parent or FALSE if no valid parent * has been found.