From 1e8da1f9ae32ccd1c6d19e24215e1cb293e97bbf Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Sat, 30 Jan 2010 07:54:01 +0000
Subject: [PATCH] - Patch #681538 by aspilicious, jhodgdon: improved
documentation, better @see also links.
---
includes/common.inc | 2 +-
includes/database/schema.inc | 2 +-
includes/form.inc | 23 +++++++++++------------
includes/theme.inc | 4 ++--
includes/updater.inc | 12 ++++++------
modules/system/system.admin.inc | 12 +++++++-----
modules/system/system.module | 2 +-
7 files changed, 29 insertions(+), 28 deletions(-)
diff --git a/includes/common.inc b/includes/common.inc
index d04f938eae53..ebbadc12580f 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -4559,7 +4559,7 @@ function _drupal_bootstrap_full() {
* Page compression requires the PHP zlib extension
* (http://php.net/manual/en/ref.zlib.php).
*
- * @see drupal_page_header
+ * @see drupal_page_header()
*/
function drupal_page_set_cache() {
global $base_root;
diff --git a/includes/database/schema.inc b/includes/database/schema.inc
index 670d3ab3b972..0437999d2bb0 100644
--- a/includes/database/schema.inc
+++ b/includes/database/schema.inc
@@ -300,7 +300,7 @@ abstract public function dropTable($table);
* table along with adding the field. The format is the same as a
* table specification but without the 'fields' element. If you are
* adding a type 'serial' field, you MUST specify at least one key
- * or index including it in this array. @see db_change_field for more
+ * or index including it in this array. See db_change_field() for more
* explanation why.
*/
abstract public function addField($table, $field, $spec, $keys_new = array());
diff --git a/includes/form.inc b/includes/form.inc
index 401c881b4e3e..7e86bcb4364b 100644
--- a/includes/form.inc
+++ b/includes/form.inc
@@ -2457,22 +2457,16 @@ function theme_container($variables) {
}
/**
- * Format a table with radio buttons or checkboxes.
+ * Formats a table with radio buttons or checkboxes.
*
* @param $variables
* An associative array containing:
* - element: An associative array containing the properties and children of
- * the tableselect element.
- * Each option in $variables['element']['#options'] can contain an array
- * keyed by '#attributes' which is added to the row's HTML attributes.
- * @see theme_table
- * Properties used: header, options, empty, js_select.
- *
- * @return
- * A themed HTML string representing the table.
- *
- * Example:
- *
+ * the tableselect element. Properties used: #header, #options, #empty,
+ * and #js_select. The #options property is an array of selection options;
+ * each array element of #options is an array of properties. These
+ * properties can include #attributes, which is added to the
+ * table row's HTML attributes (see theme_table()). Example:
* @code
* $options = array();
* $options[0]['title'] = "A red row"
@@ -2485,6 +2479,11 @@ function theme_container($variables) {
* '#title' => 'My Selector'
* '#options' => $options,
* );
+ * @endcode
+ *
+ * @return
+ * A themed HTML string representing the table.
+ *
* @ingroup themeable
*/
function theme_tableselect($variables) {
diff --git a/includes/theme.inc b/includes/theme.inc
index eeb7a5faf5b2..b1b2f0314ad4 100644
--- a/includes/theme.inc
+++ b/includes/theme.inc
@@ -2357,8 +2357,8 @@ function template_preprocess_html(&$variables) {
* Any changes to variables in this preprocessor should also be changed inside
* template_preprocess_maintenance_page() to keep all of them consistent.
*
- * @see drupal_render_page
- * @see template_process_page
+ * @see drupal_render_page()
+ * @see template_process_page()
* @see page.tpl.php
*/
function template_preprocess_page(&$variables) {
diff --git a/includes/updater.inc b/includes/updater.inc
index 173ea2deb17f..074d3780d1e6 100644
--- a/includes/updater.inc
+++ b/includes/updater.inc
@@ -198,11 +198,11 @@ protected function getInstallArgs($overrides = array()) {
* Updates a Drupal project, returns a list of next actions.
*
* @param FileTransfer $filetransfer
- * Object which is a child of FileTransfer. Used for moving files
+ * Object that is a child of FileTransfer. Used for moving files
* to the server.
* @param array $overrides
- * An array of settings to override defaults
- * @see self::getInstallArgs
+ * An array of settings to override defaults; see self::getInstallArgs().
+ *
* @return array
* An array of links which the user may need to complete the update
*/
@@ -254,10 +254,10 @@ public function update(&$filetransfer, $overrides = array()) {
* Installs a Drupal project, returns a list of next actions.
*
* @param FileTransfer $filetransfer
- * Object which is a child of FileTransfer.
+ * Object that is a child of FileTransfer.
* @param array $overrides
- * An array of settings to override defaults.
- * @see self::getInstallArgs
+ * An array of settings to override defaults; see self::getInstallArgs().
+ *
* @return array
* An array of links which the user may need to complete the install.
*/
diff --git a/modules/system/system.admin.inc b/modules/system/system.admin.inc
index 284d8a55f6c2..372993712c3d 100644
--- a/modules/system/system.admin.inc
+++ b/modules/system/system.admin.inc
@@ -808,9 +808,9 @@ function _system_is_incompatible(&$incompatible, $files, $file) {
/**
* Menu callback; provides module enable/disable interface.
*
- * The list of modules gets populated by module.info files, which contain each module's name,
- * description and information about which modules it requires.
- * @see drupal_parse_info_file for information on module.info descriptors.
+ * The list of modules gets populated by module.info files, which contain each
+ * module's name, description, and information about which modules it requires.
+ * See drupal_parse_info_file() for information on module.info descriptors.
*
* Dependency checking is performed to ensure that a module:
* - can not be enabled if there are disabled modules it requires.
@@ -818,11 +818,13 @@ function _system_is_incompatible(&$incompatible, $files, $file) {
*
* @param $form_state
* An associative array containing the current state of the form.
+ *
+ * @return
+ * The form array.
+ *
* @ingroup forms
* @see theme_system_modules()
* @see system_modules_submit()
- * @return
- * The form array.
*/
function system_modules($form, $form_state = array()) {
// Get current list of modules.
diff --git a/modules/system/system.module b/modules/system/system.module
index cae7a1bb4e32..02a5db5fdee7 100644
--- a/modules/system/system.module
+++ b/modules/system/system.module
@@ -1586,7 +1586,7 @@ function system_authorized_get_url(array $options = array()) {
/**
* Setup and invoke an operation using authorize.php.
*
- * @see system_authorized_init
+ * @see system_authorized_init()
*/
function system_authorized_run($callback, $file, $arguments = array(), $page_title = NULL) {
system_authorized_init($callback, $file, $arguments, $page_title);
--
GitLab