summaryrefslogtreecommitdiff
path: root/includes/install.core.inc
diff options
context:
space:
mode:
authorJennifer Hodgdon <yahgrp@poplarware.com>2012-10-10 10:31:02 -0700
committerJennifer Hodgdon <yahgrp@poplarware.com>2012-10-10 10:31:02 -0700
commitbfdecf2ee246945ee6bd56279630431e7df3e1d4 (patch)
treef49b1b585d4c531466d9d7a899c40e501933b78a /includes/install.core.inc
parente27ec205f7d9fc1398f7c46efe5a6c5e216bc3f3 (diff)
downloadbrdo-bfdecf2ee246945ee6bd56279630431e7df3e1d4.tar.gz
brdo-bfdecf2ee246945ee6bd56279630431e7df3e1d4.tar.bz2
Issue #1317626 by Albert Volkman: More API docs cleanup for includes H-M files
Diffstat (limited to 'includes/install.core.inc')
-rw-r--r--includes/install.core.inc14
1 files changed, 12 insertions, 2 deletions
diff --git a/includes/install.core.inc b/includes/install.core.inc
index 09f3cc50b..273acd95a 100644
--- a/includes/install.core.inc
+++ b/includes/install.core.inc
@@ -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';