diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc index 15ff5af1018ae952cb494500ace37209c77b691c..6deab8a79df14d4866c92715c3f3c6b6264e4d24 100644 --- a/includes/bootstrap.inc +++ b/includes/bootstrap.inc @@ -752,10 +752,12 @@ function variable_initialize($conf = array()) { * The name of the variable to return. * @param $default * The default value to use if this variable has never been set. + * * @return * The value of the variable. * - * @see variable_del(), variable_set() + * @see variable_del() + * @see variable_set() */ function variable_get($name, $default = NULL) { global $conf; @@ -772,7 +774,8 @@ function variable_get($name, $default = NULL) { * The value to set. This can be any PHP data type; these functions take care * of serialization as necessary. * - * @see variable_del(), variable_get() + * @see variable_del() + * @see variable_get() */ function variable_set($name, $value) { global $conf; @@ -790,7 +793,8 @@ function variable_set($name, $value) { * @param $name * The name of the variable to undefine. * - * @see variable_get(), variable_set() + * @see variable_get() + * @see variable_set() */ function variable_del($name) { global $conf; @@ -1438,10 +1442,12 @@ function t($string, array $args = array(), array $options = array()) { * * @param $text * The text to be checked or processed. + * * @return * An HTML safe version of $text, or an empty string if $text is not * valid UTF-8. - * @see drupal_validate_utf8(). + * + * @see drupal_validate_utf8() */ function check_plain($text) { // We do not want to use drupal_static() since PHP version will never change @@ -1455,8 +1461,8 @@ function check_plain($text) { // drupal_validate_utf8() here. This avoids the overhead of an additional // function call, since check_plain() may be called hundreds of times during // a request. For PHP 5.2.5+, this check for valid UTF-8 should be handled - // internally by PHP in htmlspecialchars(). - // @see http://www.php.net/releases/5_2_5.php + // internally by PHP in htmlspecialchars(). + // See http://www.php.net/releases/5_2_5.php. // @todo remove this when support for either IE6 or PHP < 5.2.5 is dropped. if ($php525) { @@ -2539,7 +2545,7 @@ function registry_update() { * - http://php.net/manual/en/language.variables.scope.php#language.variables.scope.static * - http://php.net/manual/en/language.variables.scope.php#language.variables.scope.references * The example below shows the syntax needed to work around both limitations. - * For benchmarks and more information, @see http://drupal.org/node/619666. + * For benchmarks and more information, see http://drupal.org/node/619666. * * Example: * @code diff --git a/includes/common.inc b/includes/common.inc index e25a744d2b26e1516d0d060a9e574ce6f94d20f2..5857aac6d8753466aadde8d34878c0d1b47ba7d2 100644 --- a/includes/common.inc +++ b/includes/common.inc @@ -818,7 +818,7 @@ function drupal_http_request($url, array $options = array()) { // Mark that this request failed. This will trigger a check of the web // server's ability to make outgoing HTTP requests the next time that // requirements checking is performed. - // @see system_requirements() + // See system_requirements() variable_set('drupal_http_request_fails', TRUE); return $result; @@ -3758,14 +3758,15 @@ function drupal_get_js($scope = 'header', $javascript = NULL) { * When TRUE, will exit if a given library's dependencies are missing. When * set to FALSE, will continue to add the libraries, even though one of the * dependencies are missing. Defaults to FALSE. + * * @return * Will return FALSE if there were any missing library dependencies. TRUE will * be returned if all library dependencies were met. * - * @see drupal_add_library(). - * @see drupal_add_js(). - * @see drupal_add_css(). - * @see drupal_render(). + * @see drupal_add_library() + * @see drupal_add_js() + * @see drupal_add_css() + * @see drupal_render() */ function drupal_process_attached($elements, $weight = JS_DEFAULT, $dependency_check = FALSE) { // Add defaults to the special attached structures that should be processed differently. @@ -4779,7 +4780,7 @@ function drupal_pre_render_markup($elements) { * - #show_messages: Suppress drupal_get_message() items. Used by Batch API (optional). * * @see hook_page_alter() - * @see element_info('page') + * @see element_info() */ function drupal_render_page($page) { $main_content_display = &drupal_static('system_main_content_added', FALSE); @@ -4845,8 +4846,8 @@ function drupal_render_page($page) { * improve performance. To use drupal_render() caching, set the element's #cache * property to an associative array with one or several of the following keys: * - 'keys': An array of one or more keys that identify the element. If 'keys' - * is set, the cache ID is created automatically from these keys. - * @see drupal_render_cid_create() + * is set, the cache ID is created automatically from these keys. See + * drupal_render_cid_create(). * - 'granularity' (optional): Define the cache granularity using binary * combinations of the cache granularity constants, e.g. DRUPAL_CACHE_PER_USER * to cache for each user separately or diff --git a/includes/database/prefetch.inc b/includes/database/prefetch.inc index 663927af726babebc7f680f8e7d5ce5d06e9b811..9d02dcfc2ed78840902d07c42614f27b242a324b 100644 --- a/includes/database/prefetch.inc +++ b/includes/database/prefetch.inc @@ -175,9 +175,8 @@ public function execute($args = array(), $options = array()) { // as soon as possible. $this->rowCount = $statement->rowCount(); $this->data = $statement->fetchAll(PDO::FETCH_ASSOC); - // Destroy the statement as soon as possible. - // See DatabaseConnection_sqlite::PDOPrepare() for explanation. - // @see DatabaseConnection_sqlite::PDOPrepare() + // Destroy the statement as soon as possible. See + // DatabaseConnection_sqlite::PDOPrepare() for explanation. unset($statement); $this->resultRowCount = count($this->data); diff --git a/includes/file.inc b/includes/file.inc index 1b06895afe6a4e1ae152d385320c97b66ac0ace9..baa0a947364c69f7fff33ca6a8f9c7a5614376db 100644 --- a/includes/file.inc +++ b/includes/file.inc @@ -536,8 +536,8 @@ function file_save(stdClass $file) { * - If file already exists in $destination either the call will error out, * replace the file or rename the file based on the $replace parameter. * - Adds the new file to the files database. If the source file is a - * temporary file, the resulting file will also be a temporary file. - * @see file_save_upload() for details on temporary files. + * temporary file, the resulting file will also be a temporary file. See + * file_save_upload() for details on temporary files. * * @param $source * A file object. @@ -553,6 +553,7 @@ function file_save(stdClass $file) { * - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is * unique. * - FILE_EXISTS_ERROR - Do nothing and return FALSE. + * * @return * File object if the copy is successful, or FALSE in the event of an error. * @@ -1070,7 +1071,7 @@ function file_unmanaged_delete_recursive($path) { function file_space_used($uid = NULL, $status = FILE_STATUS_PERMANENT) { $query = db_select('file', 'f'); // 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. $query->where('f.status & :status1 = :status2', array(':status1' => $status, ':status2' => $status)); $query->addExpression('SUM(f.filesize)', 'filesize'); if (!is_null($uid)) { @@ -1127,7 +1128,7 @@ function file_save_upload($source, $validators = array(), $destination = FALSE, // Check for file upload errors and return FALSE if a lower level system // error occurred. For a complete list of errors: - // @see http://php.net/manual/en/features.file-upload.errors.php + // See http://php.net/manual/en/features.file-upload.errors.php. switch ($_FILES['files']['error'][$source]) { case UPLOAD_ERR_INI_SIZE: case UPLOAD_ERR_FORM_SIZE: @@ -1734,8 +1735,8 @@ function file_upload_max_size() { * @return * The internet media type registered for the extension or * application/octet-stream for unknown extensions. - * @see - * file_default_mimetype_mapping() + * + * @see file_default_mimetype_mapping() */ function file_get_mimetype($uri, $mapping = NULL) { if ($wrapper = file_stream_wrapper_get_instance_by_uri($uri)) { @@ -1818,6 +1819,7 @@ function drupal_chmod($uri, $mode = NULL) { * @param $uri * A string containing the URI to verify. If this value is omitted, * Drupal's public files directory will be used [public://]. + * * @return * The absolute pathname, or FALSE on failure. * @@ -1853,6 +1855,7 @@ function drupal_realpath($uri) { * * @param $uri * A URI or path. + * * @return * A string containing the directory name. * @@ -1894,6 +1897,7 @@ function drupal_dirname($uri) { * Default to FALSE. * @param $context * Refer to http://php.net/manual/en/ref.stream.php + * * @return * Boolean TRUE on success, or FALSE on failure. * @@ -1929,6 +1933,7 @@ function drupal_mkdir($uri, $mode = NULL, $recursive = FALSE, $context = NULL) { * @param $prefix * The prefix of the generated temporary filename. * Note: Windows uses only the first three characters of prefix. + * * @return * The new temporary filename, or FALSE on failure. * diff --git a/includes/form.inc b/includes/form.inc index 35f86ef559188463b81ee711d8e294f887d44231..fe14c083b3c5622261f7eae75d0f4dfe16dc6c6d 100644 --- a/includes/form.inc +++ b/includes/form.inc @@ -61,6 +61,7 @@ * drupal_get_form(), including the unique form constructor function. For * example, the node_edit form requires that a node object is passed in here * when it is called. + * * @return * The form array. * @@ -191,9 +192,9 @@ function drupal_build_form($form_id, &$form_state) { if (!isset($form)) { // Record the filepath of the include file containing the original form, // so the form builder callbacks can be loaded when the form is being - // rebuilt from cache on a different path (such as 'system/ajax'). - // @see form_get_cache() - // menu_get_item() is not available at installation time. + // rebuilt from cache on a different path (such as 'system/ajax'). See + // form_get_cache(). + // $menu_get_item() is not available at installation time. if (!isset($form_state['build_info']['file']) && !defined('MAINTENANCE_MODE')) { $item = menu_get_item(); if (!empty($item['file'])) { @@ -357,7 +358,7 @@ function form_get_cache($form_build_id, &$form_state) { $form_state = $cached->data + $form_state; // If the original form is contained in an include file, load the file. - // @see drupal_build_form() + // See drupal_build_form(). if (!empty($form_state['build_info']['file']) && file_exists($form_state['build_info']['file'])) { require_once DRUPAL_ROOT . '/' . $form_state['build_info']['file']; } @@ -553,8 +554,7 @@ function drupal_retrieve_form($form_id, &$form_state) { // builder function to pre-populate the $form array with form elements, which // the actual form builder function ($callback) expects. This allows for // pre-populating a form with common elements for certain forms, such as - // back/next/save buttons in multi-step form wizards. - // @see drupal_build_form() + // back/next/save buttons in multi-step form wizards. See drupal_build_form(). if (isset($form_state['wrapper_callback']) && function_exists($form_state['wrapper_callback'])) { $form = call_user_func_array($form_state['wrapper_callback'], $args); // Put the prepopulated $form into $args. @@ -1088,7 +1088,7 @@ function form_execute_handlers($type, &$form, &$form_state) { * assume that certain data exists within $form_state['values'], and while not * doing anything with that data that requires it to be valid, PHP errors * would be triggered if the input processing and validation steps were fully - * skipped. @see http://drupal.org/node/370537. + * skipped. See http://drupal.org/node/370537. * * @return * Return value is for internal use only. To get a list of errors, use diff --git a/includes/menu.inc b/includes/menu.inc index a8df5ba87e27af531a356401ca530be07e9fdc7f..5ce50daeea50a7b707cbaab1be6b0f364326dc73 100644 --- a/includes/menu.inc +++ b/includes/menu.inc @@ -287,6 +287,7 @@ * @param $parts * An array of path parts, for the above example * array('node', '12345', 'edit'). + * * @return * An array which contains the ancestors and placeholders. Placeholders * simply contain as many '%s' as the ancestors. @@ -341,6 +342,7 @@ function menu_get_ancestors($parts) { * A serialized array. * @param @map * An array of potential replacements. + * * @return * The $data array unserialized and mapped. */ @@ -383,6 +385,7 @@ function menu_set_item($path, $router_item) { * node/% item and return that. * @param $router_item * Internal use only. + * * @return * The router item, an associate array corresponding to one row in the * menu_router table. The value of key map holds the loaded objects. The @@ -492,6 +495,7 @@ function menu_execute_active_handler($path = NULL, $deliver = TRUE) { * A menu router or menu link item * @param $map * An array of path arguments (ex: array('node', '5')) + * * @return * Returns TRUE for success, FALSE if an object cannot be loaded. * Names of object loading functions are placed in $item['load_functions']. @@ -601,6 +605,7 @@ function _menu_check_access(&$item, $map) { * @param $link_translate * TRUE if we are translating a menu link item; FALSE if we are * translating a menu router item. + * * @return * No return value. * $item['title'] is localized according to $item['title_callback']. @@ -687,6 +692,7 @@ function _menu_item_localize(&$item, $map, $link_translate = FALSE) { * @param $to_arg * Execute $item['to_arg_functions'] or not. Use only if you want to render a * path from the menu table, for example tabs. + * * @return * Returns the map with objects loaded as defined in the * $item['load_functions']. $item['access'] becomes TRUE if the item is @@ -761,6 +767,7 @@ function menu_tail_to_arg($arg, $map, $index) { * * @param $item * A menu link + * * @return * Returns the map of path arguments with objects loaded as defined in the * $item['load_functions']. @@ -853,11 +860,12 @@ function menu_get_object($type = 'node', $position = 1, $path = NULL) { * Render a menu tree based on the current path. * * The tree is expanded based on the current path and dynamic paths are also - * changed according to the defined to_arg functions (for example the 'My account' - * link is changed from user/% to a link with the current user's uid). + * changed according to the defined to_arg functions (for example the 'My + * account' link is changed from user/% to a link with the current user's uid). * * @param $menu_name * The name of the menu. + * * @return * The rendered HTML of that menu on the current page. */ @@ -881,6 +889,7 @@ function menu_tree($menu_name) { * * @param $tree * A data structure representing the tree as returned from menu_tree_data. + * * @return * A structured array to be rendered by drupal_render(). */ @@ -1317,6 +1326,7 @@ function _menu_tree_check_access(&$tree) { * to the root of the menu tree. * @param $depth * The minimum depth of any link in the $links array. + * * @return * See menu_tree_page_data for a description of the data structure. */ @@ -1604,6 +1614,7 @@ function menu_secondary_menu() { * The name of the menu. * @param $level * Optional, the depth of the menu to be returned. + * * @return * An array of links of the specified menu and level. */ @@ -1651,6 +1662,7 @@ function menu_navigation_links($menu_name, $level = 0) { * * @param $level * The level of tasks you ask for. Primary tasks are 0, secondary are 1. + * * @return * An array containing * - tabs: Local tasks for the requested level: @@ -2036,6 +2048,7 @@ function menu_set_active_item($path) { * @param $new_trail * Menu trail to set, or NULL to use previously-set or calculated trail. If * supplying a trail, use the same format as the return value (see below). + * * @return * Path to menu root of the current page, as an array of menu link items, * starting with the site's home page. Each link item is an associative array @@ -2187,6 +2200,7 @@ function menu_get_active_title() { * * @param $mlid * The mlid of the menu item. + * * @return * A menu link, with $item['access'] filled and link translated for * rendering. @@ -2592,13 +2606,14 @@ function _menu_delete_item($item, $force = FALSE) { * @param $item * An array representing a menu link item. The only mandatory keys are * link_path and link_title. Possible keys are: - * - menu_name default is navigation - * - weight default is 0 - * - expanded whether the item is expanded. - * - options An array of options, @see l for more. - * - mlid Set to an existing value, or 0 or NULL to insert a new link. - * - plid The mlid of the parent. - * - router_path The path of the relevant router item. + * - menu_name: Default is navigation + * - weight: Default is 0 + * - expanded: Whether the item is expanded. + * - options: An array of options, see l() for more. + * - mlid: Set to an existing value, or 0 or NULL to insert a new link. + * - plid: The mlid of the parent. + * - router_path: The path of the relevant router item. + * * @return * The mlid of the saved menu link, or FALSE if the menu link could not be * saved. @@ -2820,6 +2835,7 @@ function _menu_set_expanded_menus() { * * @param $link_path * The path for we are looking up its router path. + * * @return * A path from $menu keys or empty if $link_path points to a nonexisting * place. @@ -2903,6 +2919,7 @@ function menu_link_maintain($module, $op, $link_path, $link_title) { * * @param $item * An array representing a menu link item. + * * @return * The relative depth, or zero. * @@ -3313,6 +3330,7 @@ function _menu_router_save($menu, $masks) { * If this is set to TRUE, the function will perform the access checks and * return the site offline status, but not log the user out or display any * messages. + * * @return * FALSE if the site is not in maintenance mode, the user login page is * displayed, or the user has the 'access site in maintenance mode' diff --git a/includes/module.inc b/includes/module.inc index 3d9108c896b5635a43176aea5764ba297a3422bf..10996eb655a267fffad7273ef8e7e4e75e691200 100644 --- a/includes/module.inc +++ b/includes/module.inc @@ -536,7 +536,7 @@ function module_hook($module, $hook) { * @return * An array with the names of the modules which are implementing this hook. * - * @see module_implements_write_cache(). + * @see module_implements_write_cache() */ function module_implements($hook, $sort = FALSE, $reset = FALSE) { // Use the advanced drupal_static() pattern, since this is called very often. diff --git a/includes/registry.inc b/includes/registry.inc index 5af4d4aa1986870145a821ce2fc076e34ff76694..c06dbe767e4873f2bdc3830d8af32be8bc057ec3 100644 --- a/includes/registry.inc +++ b/includes/registry.inc @@ -17,7 +17,7 @@ */ /** - * @see registry_update(). + * Does the work for registry_update(). */ function _registry_update() { diff --git a/includes/stream_wrappers.inc b/includes/stream_wrappers.inc index adb279b00a424a8dfd79bfeeaaa3c4c4e35a41d2..288c3979d237cf1a4f7ff3fff2c1ffa57cd7bae3 100644 --- a/includes/stream_wrappers.inc +++ b/includes/stream_wrappers.inc @@ -16,8 +16,8 @@ * delimiter is in general just ":", not "://". Because of this PHP limitation * and for consistency Drupal will only accept URIs of form "scheme://target". * - * @link http://www.faqs.org/rfcs/rfc3986.html - * @link http://bugs.php.net/bug.php?id=47070 + * @see http://www.faqs.org/rfcs/rfc3986.html + * @see http://bugs.php.net/bug.php?id=47070 */ /** diff --git a/includes/theme.inc b/includes/theme.inc index 65da03de3bed7b689108e753b325b95c981f7f9f..a93dd0dd775034c880f4a4cb9301556207eee857 100644 --- a/includes/theme.inc +++ b/includes/theme.inc @@ -430,7 +430,7 @@ function _theme_process_registry(&$cache, $name, $type, $theme, $path) { } foreach ($prefixes as $prefix) { // Only use non-hook-specific variable processors for theming hooks - // implemented as templates. @see theme(). + // implemented as templates. See theme(). if (isset($info['template']) && function_exists($prefix . '_' . $phase)) { $info[$phase_key][] = $prefix . '_' . $phase; } @@ -467,7 +467,7 @@ function _theme_process_registry(&$cache, $name, $type, $theme, $path) { $cache[$hook][$phase_key] = array(); } // Only use non-hook-specific variable processors for theming hooks - // implemented as templates. @see theme(). + // implemented as templates. See theme(). if (isset($info['template']) && function_exists($name . '_' . $phase)) { $cache[$hook][$phase_key][] = $name . '_' . $phase; } @@ -1083,7 +1083,7 @@ function drupal_find_theme_templates($cache, $extension, $path) { } // Find templates that implement possible "suggestion" variants of registered - // theme hooks and add those as new registered theme hooks. @see + // theme hooks and add those as new registered theme hooks. See // drupal_find_theme_functions() for more information about suggestions and // the use of 'pattern' and 'base hook'. $patterns = array_keys($files); @@ -1788,8 +1788,8 @@ function theme_tablesort_indicator($variables) { * * @param $variables * An associative array containing: - * - type: Number representing the marker type to display. - * @see MARK_NEW, MARK_UPDATED, MARK_READ + * - type: Number representing the marker type to display. See MARK_NEW, + * MARK_UPDATED, MARK_READ. * * @return * A string containing the marker. @@ -1957,7 +1957,7 @@ function theme_more_link($variables) { * that the final string is safe to include directly in the output by using * check_plain() or filter_xss(). * - * @see theme_username(). + * @see theme_username() */ function template_preprocess_username(&$variables) { $account = $variables['account']; @@ -2009,7 +2009,7 @@ function template_preprocess_username(&$variables) { /** * Process variables for theme_username(). * - * @see theme_username(). + * @see theme_username() */ function template_process_username(&$variables) { // Finalize the link_options array for passing to the l() function. diff --git a/modules/comment/comment.module b/modules/comment/comment.module index ee586e8e37f9c577d3cea144d8f06cf4405d04d2..c88ac3562742ce6d9a6b562796a3ba1c6f356acf 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 64b23e9294a901db5b396665e553bebf1450386b..92585935592fdaeb886e3fc5632f7d597f185fff 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 cb22b164c12b31f3e4b6cb9287f2553664745d83..4122000c468a80f112c7787a705c4537272bf723 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 e2015d7c28e17cddd7927b9d840c50f53c09179e..7f911dc1cdaf3512884865a53403f65fa57a7f44 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 96aa51fc83c301c3aaffabbdb51476fd88f76aa4..2f329b136701e4c853bb20064a3fb133d34094c3 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 9685a2bb93a5f4318a3860d47af9eab3167714ef..76e8f9c8cc2f2af4dadddb6c308370467a7a6f64 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 3b5cdc7b5a639833914a3e0e2e94c8b871c54dec..8fa4820b4ab2121853c7ce5aa35f18d1f1e5cbd8 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 8478d15a6b86622cd4efca8dffc387a6f25baf7e..8f317c93b286b6b91fd46566369356d5a3e94678 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 ee701db9fcf9904b704008860fa7ae68632f5d4a..4b7e0a3c31baf0fe21ccf8ced9c086482f8578e5 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 bec8d947a6bc06cf44c4557f62b5f21ff173b5b6..def0037c83763c60d13dbd621448b553663870d6 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_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 36211c851eed1ef01e8d3d7871e66548a623cb04..e290b4f391dcace5bd426807f98af1ee83121795 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 40e95eb864ca2bdcf8501d51ec483e2ec0e4bd88..ae8f5fb317de175e8d30e2783379ae2a0fad362a 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 992ed49f93e53d25a5a5977ace7ebc03e920dd75..f7120c5acfbeefd1a0d6a6fde9a1acd14866fb02 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 6793be60082b4377be99b1994c523160d5002c47..76ac111f700687be3f0ed0b7d2dae85227d273c8 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 58c0b9a30cf361ea4a72e9f8628358760f27dda3..1b5596be33cbdf23c08647f5eb8c978fecb70ba6 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 48518d9f09113499541eb4046ade383afbe41e5d..166dbcec1ac34c3a5070f775267e7a078391b3db 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 4cee5f45214c1f2f31a12f1e265197395472a740..c69d9d0227ff03f7a259696dba941b83eb9360f4 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 97d3c33bf67280b7ae228d9860e06b33f175103d..cc18d5f412c91c4647b56e0d0e174016ea3189bf 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 b34c7b5436cc7ec06af9931385741184ce3868d9..c7eea9f986ebf02cdf5efefaedc5b71c5085615e 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 9c36d0e2fe118ff0fe2564656e355dd442bb8dcc..eaf86e47bfd4bb0137dc8a5656699da6c1564e88 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 c09d9a312d5863a26685321e7fcb9539c89cee6d..d8b9d87d996defaac959d10046d97ea3f608e601 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 9d0e7efaed4a5cf19fecb9d805ef6a86e97a6dad..b14dd6ef4f51d53003610371eb2206f391ad6035 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 b19ca765571a4d8c5c889968dd319d310e8617cc..3c447d14d81aaba529db47620339140f739dce2b 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 7be851d2c55cf3484fcdf8dcc1c3a6cfadf662ee..ad9be7032250fb8d5346b9bf965253bf9faf6268 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 e5c3f0e42b57d8f11521ee673ce5029a0ea762b4..75c1b23ef5e2830dacbc2b592e0cc2b4d93984e1 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 6ff9be0ec17cce557e07344143817863a68de6e5..d248e3be9ee05018f1349bbe5292bed9bce68717 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 a3766e22c67a58f5fe80ff42420a2f2f9312be34..bdef35d5c3f82b64349d36c86db87bca4d8adb3c 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 6c5cbe11986fc8c56f506b87f97718114ba5b0b7..03952873875887454eda632897aafa04fe5d8ade 100644 --- a/modules/system/system.module +++ b/modules/system/system.module @@ -47,12 +47,16 @@ 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 0f7834e80dbea558852eefbe3e6e13bf7c8e7842..23c7007416be4d0806887dea2bc9d4e1e8dc9d56 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 406880ebf6fe968650f121b57c5c1ba7a8453c7a..af81f6b01537ddca0a3bc9d3e92502c499d69861 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'); diff --git a/profiles/standard/standard.install b/profiles/standard/standard.install index 5caacb894592229fd5cb8fb0d829dbe1db2b49ff..ff10e0b9c28f9f43de634dca3578da61fcee3a4a 100644 --- a/profiles/standard/standard.install +++ b/profiles/standard/standard.install @@ -315,7 +315,7 @@ function standard_install() { // Create an image field named "Image", enabled for the 'article' content type. // Many of the following values will be defaulted, they're included here as an illustrative examples. - // @see: http://api.drupal.org/api/function/field_create_field/7 + // See http://api.drupal.org/api/function/field_create_field/7 $field = array( 'field_name' => 'field_image', @@ -337,7 +337,7 @@ function standard_install() { // Many of the following values will be defaulted, they're included here as an illustrative examples. - // @see: http://api.drupal.org/api/function/field_create_instance/7 + // See http://api.drupal.org/api/function/field_create_instance/7 $instance = array( 'field_name' => 'field_image', 'object_type' => 'node',