Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #1317626 by Albert Volkman: More API docs cleanup for includes H-M files

merge-requests/26/head
Jennifer Hodgdon 2012-10-10 10:31:02 -07:00
parent e27ec205f7
commit bfdecf2ee2
3 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
includes/install.core.inc
View File

@ -847,6 +847,7 @@ function install_verify_pdo() {
*
* @see install_settings_form_validate()
* @see install_settings_form_submit()
* @ingroup forms
*/
function install_settings_form($form, &$form_state, &$install_state) {
global $databases;
@ -1070,6 +1071,8 @@ function _install_select_profile($profiles) {
* Array of metadata about state of form processing.
* @param $profile_files
* Array of .profile files, as returned from file_scan_directory().
*
* @ingroup forms
*/
function install_select_profile_form($form, &$form_state, $profile_files) {
$profiles = array();
@ -1246,7 +1249,9 @@ function install_select_locale(&$install_state) {
}
/**
* Form API array definition for language selection.
* Form constructor for the language selection form.
*
* @ingroup forms
*/
function install_select_locale_form($form, &$form_state, $locales, $profilename) {
include_once DRUPAL_ROOT . '/includes/iso.inc';
@ -1419,6 +1424,7 @@ function install_import_locales(&$install_state) {
*
* @see install_configure_form_validate()
* @see install_configure_form_submit()
* @ingroup forms
*/
function install_configure_form($form, &$form_state, &$install_state) {
drupal_set_title(st('Configure site'));
@ -1671,11 +1677,15 @@ function install_check_requirements($install_state) {
}
/**
* Returns a Form API array definition for site configuration.
* Form constructor for a site configuration form.
*
* @param $install_state
* An array of information about the current installation state.
*
* @see install_configure_form()
* @see install_configure_form_validate()
* @see install_configure_form_submit()
* @ingroup forms
*/
function _install_configure_form($form, &$form_state, &$install_state) {
include_once DRUPAL_ROOT . '/includes/locale.inc';

3
includes/mail.inc
View File

@ -340,6 +340,9 @@ interface MailSystemInterface {
* @param $indent (optional)
* A string to indent the text with. Only '>' characters are repeated on
* subsequent wrapped lines. Others are replaced by spaces.
*
* @return
* The content of the email as a string with formatting applied.
*/
function drupal_wrap_mail($text, $indent = '') {
// Convert CRLF into LF.

10
includes/menu.inc
View File

@ -607,7 +607,7 @@ function _menu_load_objects(&$item, &$map) {
}
/**
* Checks access to a menu item using the access callback
* Checks access to a menu item using the access callback.
*
* @param $item
* A menu router or menu link item
@ -1592,7 +1592,7 @@ function _menu_tree_data(&$links, $parents, $depth) {
}
/**
* Preprocesses the rendered tree for theme_menu_tree().
* Implements template_preprocess_HOOK() for theme_menu_tree().
*/
function template_preprocess_menu_tree(&$variables) {
$variables['tree'] = $variables['tree']['#children'];
@ -2260,7 +2260,13 @@ function menu_local_tabs() {
/**
* Returns HTML for primary and secondary local tasks.
*
* @param $variables
* An associative array containing:
* - primary: (optional) An array of local tasks (tabs).
* - secondary: (optional) An array of local tasks (tabs).
*
* @ingroup themeable
* @see menu_local_tasks()
*/
function theme_menu_local_tasks(&$variables) {
$output = '';