summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJennifer Hodgdon2012-10-10 17:31:02 (GMT)
committer Jennifer Hodgdon2012-10-10 17:31:02 (GMT)
commitbfdecf2ee246945ee6bd56279630431e7df3e1d4 (patch)
treef49b1b585d4c531466d9d7a899c40e501933b78a
parente27ec205f7d9fc1398f7c46efe5a6c5e216bc3f3 (diff)
Issue #1317626 by Albert Volkman: More API docs cleanup for includes H-M files
-rw-r--r--includes/install.core.inc14
-rw-r--r--includes/mail.inc3
-rw-r--r--includes/menu.inc10
3 files changed, 23 insertions, 4 deletions
diff --git a/includes/install.core.inc b/includes/install.core.inc
index 09f3cc5..273acd9 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';
diff --git a/includes/mail.inc b/includes/mail.inc
index e309372..8479d8e 100644
--- a/includes/mail.inc
+++ b/includes/mail.inc
@@ -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.
diff --git a/includes/menu.inc b/includes/menu.inc
index ae83a41..0cb9d23 100644
--- a/includes/menu.inc
+++ b/includes/menu.inc
@@ -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 = '';