summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2010-03-26 17:14:46 +0000
committerDries Buytaert <dries@buytaert.net>2010-03-26 17:14:46 +0000
commitd428fe37b91d9fb04b62d19d8ce04da32a1ac96c (patch)
tree560f70b5053c1663aecc62df18ffb3ab30aabcfb /modules
parent94d0be55b4580086b214f4abbf33858e3f2535ba (diff)
downloadbrdo-d428fe37b91d9fb04b62d19d8ce04da32a1ac96c.tar.gz
brdo-d428fe37b91d9fb04b62d19d8ce04da32a1ac96c.tar.bz2
- Patch #681538 by aspilicious, jhodgdon, trevjs: fixed possibly broken @see also links.
Diffstat (limited to 'modules')
-rw-r--r--modules/comment/comment.module10
-rw-r--r--modules/field/field.api.php42
-rw-r--r--modules/field/field.attach.inc4
-rw-r--r--modules/field/field.info.inc4
-rw-r--r--modules/field/modules/list/list.module2
-rw-r--r--modules/field/modules/text/text.module3
-rw-r--r--modules/field/tests/field.test2
-rw-r--r--modules/field/theme/field.tpl.php2
-rw-r--r--modules/filter/filter.api.php12
-rw-r--r--modules/filter/filter.module2
-rw-r--r--modules/forum/forum-topic-list.tpl.php3
-rw-r--r--modules/forum/forum.module2
-rw-r--r--modules/image/image.effects.inc4
-rw-r--r--modules/node/node.api.php2
-rw-r--r--modules/node/node.module3
-rw-r--r--modules/node/tests/node_test.module2
-rw-r--r--modules/overlay/overlay-parent.js16
-rw-r--r--modules/rdf/rdf.module4
-rw-r--r--modules/simpletest/simpletest.install2
-rw-r--r--modules/simpletest/tests/actions.test2
-rw-r--r--modules/simpletest/tests/database_test.test4
-rw-r--r--modules/simpletest/tests/file_test.module23
-rw-r--r--modules/simpletest/tests/form.test4
-rw-r--r--modules/simpletest/tests/form_test.module2
-rw-r--r--modules/simpletest/tests/image_test.module3
-rw-r--r--modules/system/system.api.php7
-rw-r--r--modules/system/system.install5
-rw-r--r--modules/system/system.module25
-rw-r--r--modules/trigger/trigger.api.php2
-rw-r--r--modules/update/update.module2
30 files changed, 116 insertions, 84 deletions
diff --git a/modules/comment/comment.module b/modules/comment/comment.module
index ee586e8e3..c88ac3562 100644
--- a/modules/comment/comment.module
+++ b/modules/comment/comment.module
@@ -123,8 +123,7 @@ function comment_entity_info() {
// of local tasks. Note that the paths use a different placeholder name
// and thus a different menu loader callback, so that Field UI page
// callbacks get a comment bundle name from the node type in the URL.
- // @see comment_node_type_load()
- // @see comment_menu_alter()
+ // See comment_node_type_load() and comment_menu_alter().
'path' => 'admin/structure/types/manage/%comment_node_type/comment',
'bundle argument' => 4,
'real path' => 'admin/structure/types/manage/' . str_replace('_', '-', $type) . '/comment',
@@ -1660,7 +1659,7 @@ function comment_get_display_ordinal($cid, $node_type) {
else {
// For threaded comments, the c.thread column is used for ordering. We can
// use the vancode for comparison, but must remove the trailing slash.
- // @see comment_view_multiple().
+ // See comment_view_multiple().
$query->where('SUBSTRING(c1.thread, 1, (LENGTH(c1.thread) -1)) < SUBSTRING(c2.thread, 1, (LENGTH(c2.thread) -1))');
}
@@ -1697,9 +1696,10 @@ function comment_edit_page($comment) {
/**
* Generate the basic commenting form, for appending to a node or display on a separate page.
*
- * @ingroup forms
* @see comment_form_validate()
* @see comment_form_submit()
+ *
+ * @ingroup forms
*/
function comment_form($form, &$form_state, $comment) {
global $user;
@@ -2511,7 +2511,7 @@ function comment_menu_alter(&$items) {
$items['admin/content']['description'] = "Administer content and comments";
// Adjust the Field UI tabs on admin/structure/types/manage/[node-type].
- // @see comment_entity_info()
+ // See comment_entity_info().
$items['admin/structure/types/manage/%comment_node_type/comment/fields']['title'] = 'Comment fields';
$items['admin/structure/types/manage/%comment_node_type/comment/fields']['weight'] = 3;
$items['admin/structure/types/manage/%comment_node_type/comment/display']['title'] = 'Comment display';
diff --git a/modules/field/field.api.php b/modules/field/field.api.php
index 64b23e929..925859355 100644
--- a/modules/field/field.api.php
+++ b/modules/field/field.api.php
@@ -94,26 +94,26 @@ function hook_field_extra_fields_alter(&$info) {
* can be attached to a fieldable entity. hook_field_info() defines the basic
* properties of a field type, and a variety of other field hooks are called by
* the Field Attach API to perform field-type-specific actions.
- * @see hook_field_info().
- * @see hook_field_info_alter().
- * @see hook_field_schema().
- * @see hook_field_load().
- * @see hook_field_validate().
- * @see hook_field_presave().
- * @see hook_field_insert().
- * @see hook_field_update().
- * @see hook_field_delete().
- * @see hook_field_delete_revision().
- * @see hook_field_prepare_view().
- * @see hook_field_is_empty().
+ * @see hook_field_info()
+ * @see hook_field_info_alter()
+ * @see hook_field_schema()
+ * @see hook_field_load()
+ * @see hook_field_validate()
+ * @see hook_field_presave()
+ * @see hook_field_insert()
+ * @see hook_field_update()
+ * @see hook_field_delete()
+ * @see hook_field_delete_revision()
+ * @see hook_field_prepare_view()
+ * @see hook_field_is_empty()
*
* The Field Types API also defines two kinds of pluggable handlers: widgets
* and formatters, which specify how the field appears in edit forms and in
* displayed entities. Widgets and formatters can be implemented by a field-type
* module for it's own field types, or by a third-party module to extend the
* behavior of existing field types.
- * @see hook_field_widget_info().
- * @see hook_field_formatter_info().
+ * @see hook_field_widget_info()
+ * @see hook_field_formatter_info()
*
* A third kind of pluggable handlers, storage backends, is defined by the
* @link field_storage Field Storage API @endlink.
@@ -541,9 +541,9 @@ function hook_field_is_empty($item, $field) {
* Widgets are Form API elements with additional processing capabilities.
* Widget hooks are typically called by the Field Attach API during the
* creation of the field form structure with field_attach_form().
- * @see hook_field_widget_info_alter().
- * @see hook_field_widget_form().
- * @see hook_field_widget_error().
+ * @see hook_field_widget_info_alter()
+ * @see hook_field_widget_form()
+ * @see hook_field_widget_error()
*
* @return
* An array describing the widget types implemented by the module.
@@ -713,10 +713,10 @@ function hook_field_widget_error($element, $error, $form, &$form_state) {
* called by the Field Attach API field_attach_prepare_view() and
* field_attach_view() functions.
*
- * @see hook_field_formatter_info().
- * @see hook_field_formatter_info_alter().
- * @see hook_field_formatter_view().
- * @see hook_field_formatter_prepare_view().
+ * @see hook_field_formatter_info()
+ * @see hook_field_formatter_info_alter()
+ * @see hook_field_formatter_view()
+ * @see hook_field_formatter_prepare_view()
*
* @return
* An array describing the formatter types implemented by the module.
diff --git a/modules/field/field.attach.inc b/modules/field/field.attach.inc
index cb22b164c..4122000c4 100644
--- a/modules/field/field.attach.inc
+++ b/modules/field/field.attach.inc
@@ -390,7 +390,7 @@ function _field_invoke_multiple($op, $entity_type, $entities, &$a = NULL, &$b =
* Use _field_invoke() to invoke the field type implementation,
* hook_field_[op]().
*
- * @see _field_invoke().
+ * @see _field_invoke()
*/
function _field_invoke_default($op, $entity_type, $entity, &$a = NULL, &$b = NULL, $options = array()) {
$options['default'] = TRUE;
@@ -404,7 +404,7 @@ function _field_invoke_default($op, $entity_type, $entity, &$a = NULL, &$b = NUL
* Use _field_invoke_multiple() to invoke the field type implementation,
* hook_field_[op]().
*
- * @see _field_invoke_multiple().
+ * @see _field_invoke_multiple()
*/
function _field_invoke_multiple_default($op, $entity_type, $entities, &$a = NULL, &$b = NULL, $options = array()) {
$options['default'] = TRUE;
diff --git a/modules/field/field.info.inc b/modules/field/field.info.inc
index e2015d7c2..7f911dc1c 100644
--- a/modules/field/field.info.inc
+++ b/modules/field/field.info.inc
@@ -535,7 +535,7 @@ function field_info_fields() {
* additional element 'bundles', whose value is an array of all the bundles
* this field belongs to.
*
- * @see field_info_field_by_id().
+ * @see field_info_field_by_id()
*/
function field_info_field($field_name) {
$info = _field_info_collate_fields();
@@ -556,7 +556,7 @@ function field_info_field($field_name) {
* additional element 'bundles', whose value is an array of all the bundles
* this field belongs to.
*
- * @see field_info_field().
+ * @see field_info_field()
*/
function field_info_field_by_id($field_id) {
$info = _field_info_collate_fields();
diff --git a/modules/field/modules/list/list.module b/modules/field/modules/list/list.module
index 96aa51fc8..2f329b136 100644
--- a/modules/field/modules/list/list.module
+++ b/modules/field/modules/list/list.module
@@ -292,7 +292,7 @@ function list_field_is_empty($item, $field) {
* The List module does not implement widgets of its own, but reuses the
* widgets defined in options.module.
*
- * @see list_options_list().
+ * @see list_options_list()
*/
function list_field_widget_info_alter(&$info) {
$widgets = array(
diff --git a/modules/field/modules/text/text.module b/modules/field/modules/text/text.module
index 9685a2bb9..76e8f9c8c 100644
--- a/modules/field/modules/text/text.module
+++ b/modules/field/modules/text/text.module
@@ -199,7 +199,8 @@ function text_field_validate($entity_type, $entity, $field, $instance, $langcode
* Where possible, generate the sanitized version of each field early so that
* it is cached in the field cache. This avoids looking up from the filter cache
* separately.
- * @see text_field_formatter_view().
+ *
+ * @see text_field_formatter_view()
*/
function text_field_load($entity_type, $entities, $field, $instances, $langcode, &$items) {
foreach ($entities as $id => $entity) {
diff --git a/modules/field/tests/field.test b/modules/field/tests/field.test
index 3b5cdc7b5..8fa4820b4 100644
--- a/modules/field/tests/field.test
+++ b/modules/field/tests/field.test
@@ -17,7 +17,7 @@ class FieldTestCase extends DrupalWebTestCase {
*/
function setUp() {
// Call parent::setUp().
- // @see http://www.php.net/manual/en/function.call-user-func-array.php#73105
+ // See http://www.php.net/manual/en/function.call-user-func-array.php#73105.
$args = func_get_args();
call_user_func_array(array($this, 'parent::setUp'), $args);
// Set default storage backend.
diff --git a/modules/field/theme/field.tpl.php b/modules/field/theme/field.tpl.php
index 8478d15a6..8f317c93b 100644
--- a/modules/field/theme/field.tpl.php
+++ b/modules/field/theme/field.tpl.php
@@ -6,7 +6,7 @@
* Default template implementation to display the value of a field.
*
* This file is not used and is here as a starting point for customization only.
- * @see theme_field().
+ * @see theme_field()
*
* Available variables:
* - $items: An array of field values. Use render() to output them.
diff --git a/modules/filter/filter.api.php b/modules/filter/filter.api.php
index ee701db9f..4b7e0a3c3 100644
--- a/modules/filter/filter.api.php
+++ b/modules/filter/filter.api.php
@@ -208,8 +208,8 @@ function hook_filter_info_alter(&$info) {
* @param $format
* The format object of the format being updated.
*
- * @see hook_filter_format_update().
- * @see hook_filter_format_delete().
+ * @see hook_filter_format_update()
+ * @see hook_filter_format_delete()
*/
function hook_filter_format_insert($format) {
mymodule_cache_rebuild();
@@ -225,8 +225,8 @@ function hook_filter_format_insert($format) {
* @param $format
* The format object of the format being updated.
*
- * @see hook_filter_format_insert().
- * @see hook_filter_format_delete().
+ * @see hook_filter_format_insert()
+ * @see hook_filter_format_delete()
*/
function hook_filter_format_update($format) {
mymodule_cache_rebuild();
@@ -245,8 +245,8 @@ function hook_filter_format_update($format) {
* The format object of the site's fallback format, which is always available
* to all users.
*
- * @see hook_filter_format_insert().
- * @see hook_filter_format_update().
+ * @see hook_filter_format_insert()
+ * @see hook_filter_format_update()
*/
function hook_filter_format_delete($format, $fallback) {
// Replace the deleted format with the fallback format.
diff --git a/modules/filter/filter.module b/modules/filter/filter.module
index bec8d947a..def0037c8 100644
--- a/modules/filter/filter.module
+++ b/modules/filter/filter.module
@@ -1043,7 +1043,7 @@ function filter_dom_serialize($dom_document) {
function filter_dom_serialize_escape_cdata_element($dom_document, $dom_element, $comment_start = '//', $comment_end = '') {
foreach ($dom_element->childNodes as $node) {
if (get_class($node) == 'DOMCdataSection') {
- // @see drupal_get_js(). This code is more or less duplicated there.
+ // See drupal_get_js(). This code is more or less duplicated there.
$embed_prefix = "\n<!--{$comment_start}--><![CDATA[{$comment_start} ><!--{$comment_end}\n";
$embed_suffix = "\n{$comment_start}--><!]]>{$comment_end}\n";
$fragment = $dom_document->createDocumentFragment();
diff --git a/modules/forum/forum-topic-list.tpl.php b/modules/forum/forum-topic-list.tpl.php
index 36211c851..e290b4f39 100644
--- a/modules/forum/forum-topic-list.tpl.php
+++ b/modules/forum/forum-topic-list.tpl.php
@@ -7,7 +7,8 @@
*
* Available variables:
* - $header: The table header. This is pre-generated with click-sorting
- * information. If you need to change this, @see template_preprocess_forum_topic_list().
+ * information. If you need to change this, see
+ * template_preprocess_forum_topic_list().
* - $pager: The pager to display beneath the table.
* - $topics: An array of topics to be displayed.
* - $topic_id: Numeric id for the current forum topic.
diff --git a/modules/forum/forum.module b/modules/forum/forum.module
index 40e95eb86..ae8f5fb31 100644
--- a/modules/forum/forum.module
+++ b/modules/forum/forum.module
@@ -644,7 +644,7 @@ function forum_block_view($delta = '') {
/**
* A #pre_render callback. Lists nodes based on the element's #query property.
*
-* @see forum_block_view().
+* @see forum_block_view()
*
* @return
* A renderable array.
diff --git a/modules/image/image.effects.inc b/modules/image/image.effects.inc
index 992ed49f9..f7120c5ac 100644
--- a/modules/image/image.effects.inc
+++ b/modules/image/image.effects.inc
@@ -66,8 +66,10 @@ function image_image_effect_info() {
* following items:
* - "width": An integer representing the desired width in pixels.
* - "height": An integer representing the desired height in pixels.
+ *
* @return
* TRUE on success. FALSE on failure to resize image.
+ *
* @see image_resize()
*/
function image_resize_effect(&$image, $data) {
@@ -90,8 +92,10 @@ function image_resize_effect(&$image, $data) {
* - "height": An integer representing the desired height in pixels.
* - "upscale": A Boolean indicating that the image should be upscalled if
* the dimensions are larger than the original image.
+ *
* @return
* TRUE on success. FALSE on failure to scale image.
+ *
* @see image_scale()
*/
function image_scale_effect(&$image, $data) {
diff --git a/modules/node/node.api.php b/modules/node/node.api.php
index 6793be600..76ac111f7 100644
--- a/modules/node/node.api.php
+++ b/modules/node/node.api.php
@@ -690,7 +690,7 @@ function hook_node_validate($node, $form) {
* When $view_mode is 'rss', modules can also add extra RSS elements and
* namespaces to $node->rss_elements and $node->rss_namespaces respectively for
* the RSS item generated for this node.
- * For details on how this is used @see node_feed()
+ * For details on how this is used, see node_feed().
*
* @see taxonomy_node_view()
* @see upload_node_view()
diff --git a/modules/node/node.module b/modules/node/node.module
index 58c0b9a30..1b5596be3 100644
--- a/modules/node/node.module
+++ b/modules/node/node.module
@@ -379,6 +379,7 @@ function _node_extract_type($node) {
*
* @return
* An array of node types, keyed by the type.
+ *
* @see node_type_get_type()
*/
function node_type_get_types() {
@@ -398,7 +399,7 @@ function node_type_get_types() {
* fields used internally and defined in _node_types_build() and
* node_type_set_defaults().
*
- * @see hook_node_info();
+ * @see hook_node_info()
*/
function node_type_get_type($node) {
$type = _node_extract_type($node);
diff --git a/modules/node/tests/node_test.module b/modules/node/tests/node_test.module
index 48518d9f0..166dbcec1 100644
--- a/modules/node/tests/node_test.module
+++ b/modules/node/tests/node_test.module
@@ -40,7 +40,7 @@ function node_test_node_view($node, $view_mode) {
function node_test_node_grants($account, $op) {
// Give everyone full grants so we don't break other node tests.
// Our node access tests asserts three realms of access.
- // @see testGrantAlter()
+ // See testGrantAlter().
return array(
'test_article_realm' => array(1),
'test_page_realm' => array(1),
diff --git a/modules/overlay/overlay-parent.js b/modules/overlay/overlay-parent.js
index 4cee5f452..c69d9d022 100644
--- a/modules/overlay/overlay-parent.js
+++ b/modules/overlay/overlay-parent.js
@@ -301,10 +301,10 @@ Drupal.overlay.load = function (url) {
// Get the secondary tabs
var $secondary = self.$iframeBody.find('ul.secondary');
var $secondaryLinks = $secondary.find('> li > a');
-
+
// Check if clicked on a secondary tab
var $activeLinkSecondary = $secondaryLinks.filter(function () { return self.getPath(this) == urlPath; });
-
+
if ($activeLinkSecondary.length) {
var active_tab = Drupal.t('(active tab)');
$secondaryLinks.parent().removeClass('active').find('element-invisible:contains(' + active_tab + ')').appendTo($activeLinkSecondary);
@@ -327,7 +327,7 @@ Drupal.overlay.load = function (url) {
// While the overlay is loading, we remove the loaded class from the dialog.
// After the loading is finished, the loaded class is added back. The loaded
// class is being used to hide the iframe while loading.
- // @see overlay-parent.css .overlay-loaded #overlay-element
+ // See overlay-parent.css .overlay-loaded #overlay-element.
self.$dialog.removeClass('overlay-loaded');
self.$iframe
.bind('load.overlay-event', function () {
@@ -343,7 +343,7 @@ Drupal.overlay.load = function (url) {
});
// Get the document object of the iframe window.
- // @see http://xkr.us/articles/dom/iframe-document/
+ // See http://xkr.us/articles/dom/iframe-document/.
var iframeDocument = (iframeElement.contentWindow || iframeElement.contentDocument);
if (iframeDocument.document) {
iframeDocument = iframeDocument.document;
@@ -431,8 +431,8 @@ Drupal.overlay.bindChild = function (iframeWindow, isClosing) {
// handler interferes with use of the scroll bar in Chrome & Safari.
// After unbinding from the document we bind a handler to the dialog overlay
// which returns false to prevent event bubbling.
- // @see http://dev.jqueryui.com/ticket/4671
- // @see https://bugs.webkit.org/show_bug.cgi?id=19033
+ // See http://dev.jqueryui.com/ticket/4671.
+ // See https://bugs.webkit.org/show_bug.cgi?id=19033.
// Do the same for the click handler as prevents default handling of clicks in
// displaced regions (e.g. opening a link in a new browser tab when CTRL was
// pressed while clicking).
@@ -626,14 +626,14 @@ Drupal.overlay.innerResize = function (height) {
if (!height && self.$iframeBody) {
height = self.$iframeBody.outerHeight() + 25;
}
-
+
// Only resize when height actually is changed.
if (height && height != self.lastHeight) {
// Resize the container.
self.$container.height(height);
// Keep the dim background grow or shrink with the dialog.
$.ui.dialog.overlay.resize();
-
+
self.lastHeight = height;
}
};
diff --git a/modules/rdf/rdf.module b/modules/rdf/rdf.module
index 97d3c33bf..cc18d5f41 100644
--- a/modules/rdf/rdf.module
+++ b/modules/rdf/rdf.module
@@ -409,8 +409,8 @@ function rdf_theme() {
function rdf_process(&$variables, $hook) {
// Handles attributes needed for content not covered by title, content,
// and field items. Does this by adjusting the variable sent to the template
- // so that the template doesn't have to worry about it.
- // @see theme_rdf_template_variable_wrapper()
+ // so that the template doesn't have to worry about it. See
+ // theme_rdf_template_variable_wrapper().
if (!empty($variables['rdf_template_variable_attributes_array'])) {
foreach ($variables['rdf_template_variable_attributes_array'] as $variable_name => $attributes) {
$context = array(
diff --git a/modules/simpletest/simpletest.install b/modules/simpletest/simpletest.install
index b34c7b543..c7eea9f98 100644
--- a/modules/simpletest/simpletest.install
+++ b/modules/simpletest/simpletest.install
@@ -68,7 +68,7 @@ function simpletest_requirements($phase) {
// SimpleTest currently needs 2 cURL options which are incompatible with
// having PHP's open_basedir restriction set.
- // @see http://drupal.org/node/674304.
+ // See http://drupal.org/node/674304.
$requirements['php_open_basedir'] = array(
'title' => $t('PHP open_basedir restriction'),
'value' => $open_basedir ? $t('Enabled') : $t('Disabled'),
diff --git a/modules/simpletest/tests/actions.test b/modules/simpletest/tests/actions.test
index 9c36d0e2f..eaf86e47b 100644
--- a/modules/simpletest/tests/actions.test
+++ b/modules/simpletest/tests/actions.test
@@ -97,7 +97,7 @@ class ActionLoopTestCase extends DrupalWebTestCase {
// To prevent this test from failing when xdebug is enabled, the maximum
// recursion level should be kept low enough to prevent the xdebug
// infinite recursion protection mechanism from aborting the request.
- // @see http://drupal.org/node/587634.
+ // See http://drupal.org/node/587634.
variable_set('actions_max_stack', mt_rand(3, 12));
$this->triggerActions();
}
diff --git a/modules/simpletest/tests/database_test.test b/modules/simpletest/tests/database_test.test
index c09d9a312..d8b9d87d9 100644
--- a/modules/simpletest/tests/database_test.test
+++ b/modules/simpletest/tests/database_test.test
@@ -2247,7 +2247,7 @@ class DatabaseTaggingTestCase extends DatabaseTestCase {
/**
* Select alter tests.
*
- * @see database_test_query_alter().
+ * @see database_test_query_alter()
*/
class DatabaseAlterTestCase extends DatabaseTestCase {
@@ -2331,7 +2331,7 @@ class DatabaseAlterTestCase extends DatabaseTestCase {
/**
* Select alter tests, part 2.
*
- * @see database_test_query_alter().
+ * @see database_test_query_alter()
*/
class DatabaseAlter2TestCase extends DatabaseTestCase {
diff --git a/modules/simpletest/tests/file_test.module b/modules/simpletest/tests/file_test.module
index 9d0e7efae..b14dd6ef4 100644
--- a/modules/simpletest/tests/file_test.module
+++ b/modules/simpletest/tests/file_test.module
@@ -99,7 +99,8 @@ function _file_test_form_submit(&$form, &$form_state) {
/**
* Reset/initialize the history of calls to the file_* hooks.
*
- * @see the getter/setter functions file_test_get_calls() and file_test_reset().
+ * @see file_test_get_calls()
+ * @see file_test_reset()
*/
function file_test_reset() {
// Keep track of calls to these hooks
@@ -116,7 +117,7 @@ function file_test_reset() {
);
variable_set('file_test_results', $results);
- // These hooks will return these values, @see file_test_set_return().
+ // These hooks will return these values, see file_test_set_return().
$return = array(
'validate' => array(),
'download' => NULL,
@@ -132,9 +133,12 @@ function file_test_reset() {
* @param $op
* One of the hook_file_* operations: 'load', 'validate', 'download',
* 'references', 'insert', 'update', 'copy', 'move', 'delete'.
+ *
* @return
* Array of the parameters passed to each call.
- * @see _file_test_log_call() and file_test_reset()
+ *
+ * @see _file_test_log_call()
+ * @see file_test_reset()
*/
function file_test_get_calls($op) {
$results = variable_get('file_test_results', array());
@@ -161,7 +165,9 @@ function file_test_get_all_calls() {
* 'references', 'insert', 'update', 'copy', 'move', 'delete'.
* @param $args
* Values passed to hook.
- * @see file_test_get_calls() and file_test_reset()
+ *
+ * @see file_test_get_calls()
+ * @see file_test_reset()
*/
function _file_test_log_call($op, $args) {
$results = variable_get('file_test_results', array());
@@ -174,9 +180,12 @@ function _file_test_log_call($op, $args) {
*
* @param $op
* One of the hook_file_[validate,download,references] operations.
+ *
* @return
* Value set by file_test_set_return().
-* @see file_test_set_return() and file_test_reset().
+ *
+ * @see file_test_set_return()
+ * @see file_test_reset()
*/
function _file_test_get_return($op) {
$return = variable_get('file_test_return', array($op => NULL));
@@ -190,7 +199,9 @@ function _file_test_get_return($op) {
* One of the hook_file_[validate,download,references] operations.
* @param $value
* Value for the hook to return.
- * @see _file_test_get_return() and file_test_reset().
+ *
+ * @see _file_test_get_return()
+ * @see file_test_reset()
*/
function file_test_set_return($op, $value) {
$return = variable_get('file_test_return', array());
diff --git a/modules/simpletest/tests/form.test b/modules/simpletest/tests/form.test
index b19ca7655..3c447d14d 100644
--- a/modules/simpletest/tests/form.test
+++ b/modules/simpletest/tests/form.test
@@ -123,7 +123,7 @@ class FormsTestCase extends DrupalWebTestCase {
/**
* Test default value handling for checkboxes.
*
- * @see _form_test_checkbox().
+ * @see _form_test_checkbox()
*/
function testCheckboxProcessing() {
// First, try to submit without the required checkbox.
@@ -153,7 +153,7 @@ class FormsTestCase extends DrupalWebTestCase {
/**
* Test handling of disabled elements.
*
- * @see _form_test_disabled_elements().
+ * @see _form_test_disabled_elements()
*/
function testDisabledElements() {
// Submit the form, and fetch the default values.
diff --git a/modules/simpletest/tests/form_test.module b/modules/simpletest/tests/form_test.module
index 7be851d2c..ad9be7032 100644
--- a/modules/simpletest/tests/form_test.module
+++ b/modules/simpletest/tests/form_test.module
@@ -378,7 +378,7 @@ function _form_test_tableselect_js_select_form($form, $form_state, $action) {
* request parameter "cache" the form can be tested with caching enabled, as
* it would be the case, if the form would contain some #ajax callbacks.
*
- * @see form_test_storage_form_submit().
+ * @see form_test_storage_form_submit()
*/
function form_test_storage_form($form, &$form_state) {
if ($form_state['rebuild']) {
diff --git a/modules/simpletest/tests/image_test.module b/modules/simpletest/tests/image_test.module
index e5c3f0e42..75c1b23ef 100644
--- a/modules/simpletest/tests/image_test.module
+++ b/modules/simpletest/tests/image_test.module
@@ -25,7 +25,7 @@ function image_test_image_toolkits() {
/**
* Reset/initialize the history of calls to the toolkit functions.
*
- * @see image_test_get_all_calls().
+ * @see image_test_get_all_calls()
*/
function image_test_reset() {
// Keep track of calls to these operations
@@ -62,6 +62,7 @@ function image_test_get_all_calls() {
* 'settings', 'resize', 'rotate', 'crop', 'desaturate'.
* @param $args
* Values passed to hook.
+ *
* @see image_test_get_all_calls()
* @see image_test_reset()
*/
diff --git a/modules/system/system.api.php b/modules/system/system.api.php
index 6ff9be0ec..d248e3be9 100644
--- a/modules/system/system.api.php
+++ b/modules/system/system.api.php
@@ -503,6 +503,7 @@ function hook_exit($destination = NULL) {
*
* @param $javascript
* An array of all JavaScript being presented on the page.
+ *
* @see drupal_add_js()
* @see drupal_get_js()
* @see drupal_js_defaults()
@@ -622,6 +623,7 @@ function hook_library_alter(&$libraries, $module) {
*
* @param $css
* An array of all CSS items (files and inline CSS) being requested on the page.
+ *
* @see drupal_add_css()
* @see drupal_get_css()
*/
@@ -635,6 +637,7 @@ function hook_css_alter(&$css) {
*
* @param $commands
* An array of all commands that will be sent to the user.
+ *
* @see ajax_render()
*/
function hook_ajax_render_alter($commands) {
@@ -778,7 +781,7 @@ function hook_form_alter(&$form, &$form_state, $form_id) {
* @param $form_state
* A keyed array containing the current state of the form.
*
- * @see drupal_prepare_form().
+ * @see drupal_prepare_form()
*/
function hook_form_FORM_ID_alter(&$form, &$form_state) {
// Modification for the form with the given form ID goes here. For example, if
@@ -2739,7 +2742,7 @@ function hook_actions_delete($aid) {
* Called by actions_list() to allow modules to alter the return values from
* implementations of hook_action_info().
*
- * @see trigger_example_action_info_alter().
+ * @see trigger_example_action_info_alter()
*/
function hook_action_info_alter(&$actions) {
$actions['node_unpublish_action']['label'] = t('Unpublish and remove from public view.');
diff --git a/modules/system/system.install b/modules/system/system.install
index a3766e22c..bdef35d5c 100644
--- a/modules/system/system.install
+++ b/modules/system/system.install
@@ -2068,6 +2068,7 @@ function system_update_7030() {
/**
* Removed in favour of Drupal 6 backport.
+ *
* @see system_update_6052()
*/
function system_update_7031() {
@@ -2229,8 +2230,8 @@ function system_update_7036() {
}
$insert->execute();
- // Remove obsolete variable 'site_offline_message'.
- // @see update_fix_d7_requirements().
+ // Remove obsolete variable 'site_offline_message'. See
+ // update_fix_d7_requirements().
variable_del('site_offline_message');
}
diff --git a/modules/system/system.module b/modules/system/system.module
index 6c5cbe119..039528738 100644
--- a/modules/system/system.module
+++ b/modules/system/system.module
@@ -47,12 +47,16 @@ define('DRUPAL_OPTIONAL', 1);
define('DRUPAL_REQUIRED', 2);
/**
- * Return only visible regions. @see system_region_list().
+ * Return only visible regions.
+ *
+ * @see system_region_list()
*/
define('REGIONS_VISIBLE', 'visible');
/**
- * Return all visible regions. @see system_region_list().
+ * Return all regions.
+ *
+ * @see system_region_list()
*/
define('REGIONS_ALL', 'all');
@@ -2168,6 +2172,7 @@ function system_update_files_database(&$files, $type) {
*
* @param $type
* Either 'module' or 'theme'.
+ *
* @return
* An associative array of module or theme information keyed by name.
*
@@ -2501,7 +2506,7 @@ function system_region_list($theme_key, $show = REGIONS_ALL) {
return $list[$theme_key][$show];
}
$info = $themes[$theme_key]->info;
- // If requested, suppress hidden regions. @see block_admin_display_form().
+ // If requested, suppress hidden regions. See block_admin_display_form().
foreach ($info['regions'] as $name => $label) {
if ($show == REGIONS_ALL || !isset($info['regions_hidden']) || !in_array($name, $info['regions_hidden'])) {
$list[$theme_key][$show][$name] = $label;
@@ -2557,15 +2562,17 @@ function _system_settings_form_automatic_defaults($form) {
/**
* Add default buttons to a form and set its prefix.
*
- * @ingroup forms
- * @see system_settings_form_submit()
* @param $form
* An associative array containing the structure of the form.
* @param $automatic_defaults
* Automatically load the saved values for each field from the system variables
* (defaults to TRUE).
+ *
* @return
* The form structure.
+ *
+ * @see system_settings_form_submit()
+ * @ingroup forms
*/
function system_settings_form($form, $automatic_defaults = TRUE) {
$form['actions']['#type'] = 'container';
@@ -2771,7 +2778,7 @@ function system_cron() {
// Remove temporary files that are older than DRUPAL_MAXIMUM_TEMP_FILE_AGE.
// Use separate placeholders for the status to avoid a bug in some versions
- // of PHP. See http://drupal.org/node/352956
+ // of PHP. See http://drupal.org/node/352956.
$result = db_query('SELECT fid FROM {file} WHERE status & :permanent1 <> :permanent2 AND timestamp < :timestamp', array(
':permanent1' => FILE_STATUS_PERMANENT,
':permanent2' => FILE_STATUS_PERMANENT,
@@ -2853,12 +2860,14 @@ function system_action_info() {
/**
* Return a form definition so the Send email action can be configured.
*
- * @see system_send_email_action_validate()
- * @see system_send_email_action_submit()
* @param $context
* Default values (if we are editing an existing action instance).
+ *
* @return
* Form definition.
+ *
+ * @see system_send_email_action_validate()
+ * @see system_send_email_action_submit()
*/
function system_send_email_action_form($context) {
// Set default values for form.
diff --git a/modules/trigger/trigger.api.php b/modules/trigger/trigger.api.php
index 0f7834e80..23c700741 100644
--- a/modules/trigger/trigger.api.php
+++ b/modules/trigger/trigger.api.php
@@ -20,7 +20,7 @@
* out which actions the user has associated with your trigger, and then calling
* actions_do() to fire off the actions.
*
- * @see hook_action_info().
+ * @see hook_action_info()
*
* @return
* A nested associative array.
diff --git a/modules/update/update.module b/modules/update/update.module
index 406880ebf..af81f6b01 100644
--- a/modules/update/update.module
+++ b/modules/update/update.module
@@ -427,7 +427,7 @@ function update_create_fetch_task($project) {
/**
* Wrapper to load the include file and then refresh the release data.
*
- * @see _update_refresh();
+ * @see _update_refresh()
*/
function update_refresh() {
module_load_include('inc', 'update', 'update.fetch');