Issue #2716661 by anoopjohn: Fix 'Drupal.Commenting.FunctionComment' coding standard - Issues related to @see references

8.2.x
Alex Pott 2016-05-08 17:42:30 -05:00
parent 2e5da97b7d
commit 899f647387
45 changed files with 80 additions and 70 deletions

View File

@ -2095,7 +2095,7 @@ function hook_mail_backend_info_alter(&$info) {
* @param $countries * @param $countries
* The associative array of countries keyed by two-letter country code. * The associative array of countries keyed by two-letter country code.
* *
* @see \Drupal\Core\Locale\CountryManager::getList(). * @see \Drupal\Core\Locale\CountryManager::getList()
*/ */
function hook_countries_alter(&$countries) { function hook_countries_alter(&$countries) {
// Elbonia is now independent, so add it to the country list. // Elbonia is now independent, so add it to the country list.

View File

@ -362,13 +362,14 @@ function drupal_rewrite_settings($settings = array(), $settings_file = NULL) {
* Checks whether this token represents a scalar or NULL. * Checks whether this token represents a scalar or NULL.
* *
* @param int $type * @param int $type
* The token type * The token type.
* @see token_name().
* @param string $value * @param string $value
* The value of the token. * The value of the token.
* *
* @return bool * @return bool
* TRUE if this token represents a scalar or NULL. * TRUE if this token represents a scalar or NULL.
*
* @see token_name()
*/ */
function _drupal_rewrite_settings_is_simple($type, $value) { function _drupal_rewrite_settings_is_simple($type, $value) {
$is_integer = $type == T_LNUMBER; $is_integer = $type == T_LNUMBER;
@ -386,11 +387,12 @@ function _drupal_rewrite_settings_is_simple($type, $value) {
* string. * string.
* *
* @param int $type * @param int $type
* The token type * The token type.
* @see token_name().
* *
* @return bool * @return bool
* TRUE if this token represents a number or a string. * TRUE if this token represents a number or a string.
*
* @see token_name()
*/ */
function _drupal_rewrite_settings_is_array_index($type) { function _drupal_rewrite_settings_is_array_index($type) {
$is_integer = $type == T_LNUMBER; $is_integer = $type == T_LNUMBER;

View File

@ -17,10 +17,12 @@ class InvalidPluginDefinitionException extends PluginException {
/** /**
* Constructs a InvalidPluginDefinitionException. * Constructs a InvalidPluginDefinitionException.
* *
* For the remaining parameters see \Exception.
*
* @param string $plugin_id * @param string $plugin_id
* The plugin ID of the mapper. * The plugin ID of the mapper.
* *
* @see \Exception for the remaining parameters. * @see \Exception
*/ */
public function __construct($plugin_id, $message = '', $code = 0, \Exception $previous = NULL) { public function __construct($plugin_id, $message = '', $code = 0, \Exception $previous = NULL) {
$this->pluginId = $plugin_id; $this->pluginId = $plugin_id;

View File

@ -10,10 +10,12 @@ class PluginNotFoundException extends PluginException {
/** /**
* Construct an PluginNotFoundException exception. * Construct an PluginNotFoundException exception.
* *
* For the remaining parameters see \Exception.
*
* @param string $plugin_id * @param string $plugin_id
* The plugin ID that was not found. * The plugin ID that was not found.
* *
* @see \Exception for remaining parameters. * @see \Exception
*/ */
public function __construct($plugin_id, $message = '', $code = 0, \Exception $previous = NULL) { public function __construct($plugin_id, $message = '', $code = 0, \Exception $previous = NULL) {
if (empty($message)) { if (empty($message)) {

View File

@ -127,11 +127,11 @@ class ConfigEntityType extends EntityType implements ConfigEntityTypeInterface {
/** /**
* {@inheritdoc} * {@inheritdoc}
* *
* @see \Drupal\Core\Config\Entity\ConfigEntityStorage.
*
* @throws \Drupal\Core\Config\Entity\Exception\ConfigEntityStorageClassException * @throws \Drupal\Core\Config\Entity\Exception\ConfigEntityStorageClassException
* Exception thrown when the provided class is not an instance of * Exception thrown when the provided class is not an instance of
* \Drupal\Core\Config\Entity\ConfigEntityStorage. * \Drupal\Core\Config\Entity\ConfigEntityStorage.
*
* @see \Drupal\Core\Config\Entity\ConfigEntityStorage
*/ */
protected function checkStorageClass($class) { protected function checkStorageClass($class) {
if (!is_a($class, 'Drupal\Core\Config\Entity\ConfigEntityStorage', TRUE)) { if (!is_a($class, 'Drupal\Core\Config\Entity\ConfigEntityStorage', TRUE)) {

View File

@ -67,10 +67,10 @@ interface StorageComparerInterface {
* *
* Until the changelist has been calculated this will always be FALSE. * Until the changelist has been calculated this will always be FALSE.
* *
* @see \Drupal\Core\Config\StorageComparerInterface::createChangelist().
*
* @return bool * @return bool
* TRUE if there are changes to process and FALSE if not. * TRUE if there are changes to process and FALSE if not.
*
* @see \Drupal\Core\Config\StorageComparerInterface::createChangelist()
*/ */
public function hasChanges(); public function hasChanges();

View File

@ -374,7 +374,7 @@ class Connection extends DatabaseConnection {
* A string representing the savepoint name. By default, * A string representing the savepoint name. By default,
* "mimic_implicit_commit" is used. * "mimic_implicit_commit" is used.
* *
* @see Drupal\Core\Database\Connection::pushTransaction(). * @see Drupal\Core\Database\Connection::pushTransaction()
*/ */
public function addSavepoint($savepoint_name = 'mimic_implicit_commit') { public function addSavepoint($savepoint_name = 'mimic_implicit_commit') {
if ($this->inTransaction()) { if ($this->inTransaction()) {
@ -389,7 +389,7 @@ class Connection extends DatabaseConnection {
* A string representing the savepoint name. By default, * A string representing the savepoint name. By default,
* "mimic_implicit_commit" is used. * "mimic_implicit_commit" is used.
* *
* @see Drupal\Core\Database\Connection::popTransaction(). * @see Drupal\Core\Database\Connection::popTransaction()
*/ */
public function releaseSavepoint($savepoint_name = 'mimic_implicit_commit') { public function releaseSavepoint($savepoint_name = 'mimic_implicit_commit') {
if (isset($this->transactionLayers[$savepoint_name])) { if (isset($this->transactionLayers[$savepoint_name])) {

View File

@ -28,11 +28,11 @@ class ContentEntityType extends EntityType implements ContentEntityTypeInterface
/** /**
* {@inheritdoc} * {@inheritdoc}
* *
* @see \Drupal\Core\Entity\ContentEntityStorageInterface.
*
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* If the provided class does not implement * If the provided class does not implement
* \Drupal\Core\Entity\ContentEntityStorageInterface. * \Drupal\Core\Entity\ContentEntityStorageInterface.
*
* @see \Drupal\Core\Entity\ContentEntityStorageInterface
*/ */
protected function checkStorageClass($class) { protected function checkStorageClass($class) {
$required_interface = ContentEntityStorageInterface::class; $required_interface = ContentEntityStorageInterface::class;

View File

@ -63,7 +63,7 @@ interface QueryAggregateInterface extends QueryInterface {
* @return \Drupal\Core\Entity\Query\QueryAggregateInterface * @return \Drupal\Core\Entity\Query\QueryAggregateInterface
* The called object. * The called object.
* *
* @see \Drupal\Core\Entity\Query\QueryInterface::condition(). * @see \Drupal\Core\Entity\Query\QueryInterface::condition()
*/ */
public function conditionAggregate($field, $function = NULL, $value = NULL, $operator = '=', $langcode = NULL); public function conditionAggregate($field, $function = NULL, $value = NULL, $operator = '=', $langcode = NULL);

View File

@ -81,7 +81,7 @@ use Drupal\Core\Utility\UpdateException;
* *
* See system_hook_info() for all hook groups defined by Drupal core. * See system_hook_info() for all hook groups defined by Drupal core.
* *
* @see hook_hook_info_alter(). * @see hook_hook_info_alter()
*/ */
function hook_hook_info() { function hook_hook_info() {
$hooks['token_info'] = array( $hooks['token_info'] = array(

View File

@ -27,7 +27,7 @@ class InstallerKernel extends DrupalKernel {
* re-instantiated during a single install request. Most drivers will not * re-instantiated during a single install request. Most drivers will not
* need this method. * need this method.
* *
* @see \Drupal\Core\Database\Install\Tasks::runTasks(). * @see \Drupal\Core\Database\Install\Tasks::runTasks()
*/ */
public function resetConfigStorage() { public function resetConfigStorage() {
$this->configStorage = NULL; $this->configStorage = NULL;

View File

@ -29,8 +29,8 @@ trait LinkGeneratorTrait {
/** /**
* Renders a link to a route given a route name and its parameters. * Renders a link to a route given a route name and its parameters.
* *
* @see \Drupal\Core\Utility\LinkGeneratorInterface::generate() for details * For details on the arguments, usage, and possible exceptions see
* on the arguments, usage, and possible exceptions. * \Drupal\Core\Utility\LinkGeneratorInterface::generate().
* *
* @return \Drupal\Core\GeneratedLink * @return \Drupal\Core\GeneratedLink
* A GeneratedLink object containing a link to the given route and * A GeneratedLink object containing a link to the given route and
@ -38,6 +38,8 @@ trait LinkGeneratorTrait {
* *
* @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. * @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0.
* Use \Drupal\Core\Link instead. * Use \Drupal\Core\Link instead.
*
* @see \Drupal\Core\Utility\LinkGeneratorInterface::generate()
*/ */
protected function l($text, Url $url) { protected function l($text, Url $url) {
return $this->getLinkGenerator()->generate($text, $url); return $this->getLinkGenerator()->generate($text, $url);

View File

@ -27,14 +27,16 @@ trait UrlGeneratorTrait {
/** /**
* Generates a URL or path for a specific route based on the given parameters. * Generates a URL or path for a specific route based on the given parameters.
* *
* @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute() for * For details on the arguments, usage, and possible exceptions see
* details on the arguments, usage, and possible exceptions. * \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute().
* *
* @return string * @return string
* The generated URL for the given route. * The generated URL for the given route.
* *
* @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. * @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0.
* Use \Drupal\Core\Url instead. * Use \Drupal\Core\Url instead.
*
* @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute()
*/ */
protected function url($route_name, $route_parameters = array(), $options = array()) { protected function url($route_name, $route_parameters = array(), $options = array()) {
return $this->getUrlGenerator()->generateFromRoute($route_name, $route_parameters, $options); return $this->getUrlGenerator()->generateFromRoute($route_name, $route_parameters, $options);

View File

@ -206,10 +206,11 @@ class TwigExtension extends \Twig_Extension {
* @param array $options * @param array $options
* (optional) An associative array of additional options. The 'absolute' * (optional) An associative array of additional options. The 'absolute'
* option is forced to be FALSE. * option is forced to be FALSE.
* @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute().
* *
* @return string * @return string
* The generated URL path (relative URL) for the given route. * The generated URL path (relative URL) for the given route.
*
* @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute()
*/ */
public function getPath($name, $parameters = array(), $options = array()) { public function getPath($name, $parameters = array(), $options = array()) {
$options['absolute'] = FALSE; $options['absolute'] = FALSE;

View File

@ -720,7 +720,7 @@ class BookManager implements BookManagerInterface {
* @param array $flat * @param array $flat
* A flat array of the menu links from $tree, passed by reference. * A flat array of the menu links from $tree, passed by reference.
* *
* @see static::bookTreeGetFlat(). * @see static::bookTreeGetFlat()
*/ */
protected function flatBookTree(array $tree, array &$flat) { protected function flatBookTree(array $tree, array &$flat) {
foreach ($tree as $data) { foreach ($tree as $data) {

View File

@ -27,7 +27,7 @@
* @return array * @return array
* Returns the form array to be built. * Returns the form array to be built.
* *
* @see \Drupal\field_ui\DisplayOverView. * @see \Drupal\field_ui\DisplayOverView
*/ */
function hook_field_formatter_third_party_settings_form(\Drupal\Core\Field\FormatterInterface $plugin, \Drupal\Core\Field\FieldDefinitionInterface $field_definition, $view_mode, $form, \Drupal\Core\Form\FormStateInterface $form_state) { function hook_field_formatter_third_party_settings_form(\Drupal\Core\Field\FormatterInterface $plugin, \Drupal\Core\Field\FieldDefinitionInterface $field_definition, $view_mode, $form, \Drupal\Core\Form\FormStateInterface $form_state) {
$element = array(); $element = array();
@ -60,7 +60,7 @@ function hook_field_formatter_third_party_settings_form(\Drupal\Core\Field\Forma
* @return array * @return array
* Returns the form array to be built. * Returns the form array to be built.
* *
* @see \Drupal\field_ui\FormDisplayOverView. * @see \Drupal\field_ui\FormDisplayOverView
*/ */
function hook_field_widget_third_party_settings_form(\Drupal\Core\Field\WidgetInterface $plugin, \Drupal\Core\Field\FieldDefinitionInterface $field_definition, $form_mode, $form, \Drupal\Core\Form\FormStateInterface $form_state) { function hook_field_widget_third_party_settings_form(\Drupal\Core\Field\WidgetInterface $plugin, \Drupal\Core\Field\FieldDefinitionInterface $field_definition, $form_mode, $form, \Drupal\Core\Form\FormStateInterface $form_state) {
$element = array(); $element = array();
@ -87,7 +87,7 @@ function hook_field_widget_third_party_settings_form(\Drupal\Core\Field\WidgetIn
* - field_definition: The field definition. * - field_definition: The field definition.
* - view_mode: The view mode being configured. * - view_mode: The view mode being configured.
* *
* @see \Drupal\field_ui\DisplayOverView. * @see \Drupal\field_ui\DisplayOverView
*/ */
function hook_field_formatter_settings_summary_alter(&$summary, $context) { function hook_field_formatter_settings_summary_alter(&$summary, $context) {
// Append a message to the summary when an instance of foo_formatter has // Append a message to the summary when an instance of foo_formatter has
@ -110,7 +110,7 @@ function hook_field_formatter_settings_summary_alter(&$summary, $context) {
* - field_definition: The field definition. * - field_definition: The field definition.
* - form_mode: The form mode being configured. * - form_mode: The form mode being configured.
* *
* @see \Drupal\field_ui\FormDisplayOverView. * @see \Drupal\field_ui\FormDisplayOverView
*/ */
function hook_field_widget_settings_summary_alter(&$summary, $context) { function hook_field_widget_settings_summary_alter(&$summary, $context) {
// Append a message to the summary when an instance of foo_widget has // Append a message to the summary when an instance of foo_widget has

View File

@ -204,7 +204,6 @@ class LocaleConfigManager {
* The translatable array structure. A nested array matching the exact * The translatable array structure. A nested array matching the exact
* structure under of the default configuration for $name with only the * structure under of the default configuration for $name with only the
* elements that are translatable wrapped into a TranslatableMarkup. * elements that are translatable wrapped into a TranslatableMarkup.
* @see self::getTranslatableData().
* @param string $langcode * @param string $langcode
* The language code to process the array with. * The language code to process the array with.
* *
@ -212,6 +211,8 @@ class LocaleConfigManager {
* Processed translatable data array. Will only contain translations * Processed translatable data array. Will only contain translations
* different from source strings or in case of untranslatable English, the * different from source strings or in case of untranslatable English, the
* source strings themselves. * source strings themselves.
*
* @see self::getTranslatableData()
*/ */
protected function processTranslatableData($name, array $active, array $translatable, $langcode) { protected function processTranslatableData($name, array $active, array $translatable, $langcode) {
$translated = array(); $translated = array();

View File

@ -389,8 +389,8 @@ function menu_ui_form_node_form_submit($form, FormStateInterface $form_state) {
* *
* Adds menu options to the node type form. * Adds menu options to the node type form.
* *
* @see NodeTypeForm::form(). * @see NodeTypeForm::form()
* @see menu_ui_form_node_type_form_submit(). * @see menu_ui_form_node_type_form_submit()
*/ */
function menu_ui_form_node_type_form_alter(&$form, FormStateInterface $form_state) { function menu_ui_form_node_type_form_alter(&$form, FormStateInterface $form_state) {
/** @var \Drupal\Core\Menu\MenuParentFormSelectorInterface $menu_parent_selector */ /** @var \Drupal\Core\Menu\MenuParentFormSelectorInterface $menu_parent_selector */
@ -437,7 +437,7 @@ function menu_ui_form_node_type_form_alter(&$form, FormStateInterface $form_stat
/** /**
* Submit handler for forms with menu options. * Submit handler for forms with menu options.
* *
* @see menu_ui_form_node_type_form_alter(). * @see menu_ui_form_node_type_form_alter()
*/ */
function menu_ui_form_node_type_form_validate(&$form, FormStateInterface $form_state) { function menu_ui_form_node_type_form_validate(&$form, FormStateInterface $form_state) {
$available_menus = array_filter($form_state->getValue('menu_options')); $available_menus = array_filter($form_state->getValue('menu_options'));
@ -457,7 +457,7 @@ function menu_ui_form_node_type_form_validate(&$form, FormStateInterface $form_s
/** /**
* Entity builder for the node type form with menu options. * Entity builder for the node type form with menu options.
* *
* @see menu_ui_form_node_type_form_alter(). * @see menu_ui_form_node_type_form_alter()
*/ */
function menu_ui_form_node_type_form_builder($entity_type, NodeTypeInterface $type, &$form, FormStateInterface $form_state) { function menu_ui_form_node_type_form_builder($entity_type, NodeTypeInterface $type, &$form, FormStateInterface $form_state) {
$type->setThirdPartySetting('menu_ui', 'available_menus', array_values(array_filter($form_state->getValue('menu_options')))); $type->setThirdPartySetting('menu_ui', 'available_menus', array_values(array_filter($form_state->getValue('menu_options'))));

View File

@ -279,7 +279,7 @@ interface MigrationInterface extends PluginInspectionInterface, DerivativeInspec
* @return $this * @return $this
* The migration entity. * The migration entity.
* *
* @see Drupal\migrate_drupal\Plugin\migrate\load\LoadEntity::processLinkField(). * @see Drupal\migrate_drupal\Plugin\migrate\load\LoadEntity::processLinkField()
*/ */
public function mergeProcessOfProperty($property, array $process_of_property); public function mergeProcessOfProperty($property, array $process_of_property);

View File

@ -11,7 +11,7 @@ use Drupal\Core\Field\FieldStorageDefinitionInterface;
/** /**
* Implements callback_allowed_values_function(). * Implements callback_allowed_values_function().
* *
* @see options_allowed_values(). * @see options_allowed_values()
*/ */
function options_test_allowed_values_callback(FieldStorageDefinitionInterface $definition, FieldableEntityInterface $entity = NULL) { function options_test_allowed_values_callback(FieldStorageDefinitionInterface $definition, FieldableEntityInterface $entity = NULL) {
$values = array( $values = array(
@ -38,7 +38,7 @@ function options_test_allowed_values_callback(FieldStorageDefinitionInterface $d
* NULL. Since this is not yet used for testing Views integration, that is * NULL. Since this is not yet used for testing Views integration, that is
* alright for now. Fix this in https://www.drupal.org/node/2012130. * alright for now. Fix this in https://www.drupal.org/node/2012130.
* *
* @see options_allowed_values(). * @see options_allowed_values()
*/ */
function options_test_dynamic_values_callback(FieldStorageDefinitionInterface $definition, FieldableEntityInterface $entity = NULL, &$cacheable = NULL) { function options_test_dynamic_values_callback(FieldStorageDefinitionInterface $definition, FieldableEntityInterface $entity = NULL, &$cacheable = NULL) {
$values = array(); $values = array();

View File

@ -1302,7 +1302,7 @@ abstract class WebTestBase extends TestBase {
* @param $header * @param $header
* An header. * An header.
* *
* @see _drupal_log_error(). * @see _drupal_log_error()
*/ */
protected function curlHeaderCallback($curlHandler, $header) { protected function curlHeaderCallback($curlHandler, $header) {
// Header fields can be extended over multiple lines by preceding each // Header fields can be extended over multiple lines by preceding each

View File

@ -199,7 +199,7 @@ trait EntityDefinitionTestTrait {
/** /**
* Adds an index to the 'entity_test_update' entity type's base table. * Adds an index to the 'entity_test_update' entity type's base table.
* *
* @see \Drupal\entity_test\EntityTestStorageSchema::getEntitySchema(). * @see \Drupal\entity_test\EntityTestStorageSchema::getEntitySchema()
*/ */
protected function addEntityIndex() { protected function addEntityIndex() {
$indexes = array( $indexes = array(

View File

@ -205,7 +205,7 @@ class MenuRouterTest extends WebTestBase {
/** /**
* Make sure the maintenance mode can be bypassed using an EventSubscriber. * Make sure the maintenance mode can be bypassed using an EventSubscriber.
* *
* @see \Drupal\menu_test\EventSubscriber\MaintenanceModeSubscriber::onKernelRequestMaintenance(). * @see \Drupal\menu_test\EventSubscriber\MaintenanceModeSubscriber::onKernelRequestMaintenance()
*/ */
public function testMaintenanceModeLoginPaths() { public function testMaintenanceModeLoginPaths() {
$this->container->get('state')->set('system.maintenance_mode', TRUE); $this->container->get('state')->set('system.maintenance_mode', TRUE);

View File

@ -34,7 +34,7 @@ class SystemAuthorizeTest extends WebTestBase {
* $_SESSION inside the test site, not the framework site. This callback * $_SESSION inside the test site, not the framework site. This callback
* redirects to authorize.php when it's done initializing. * redirects to authorize.php when it's done initializing.
* *
* @see system_authorized_init(). * @see system_authorized_init()
*/ */
function drupalGetAuthorizePHP($page_title = 'system-test-auth') { function drupalGetAuthorizePHP($page_title = 'system-test-auth') {
$this->drupalGet('system-test/authorize-init/' . $page_title); $this->drupalGet('system-test/authorize-init/' . $page_title);

View File

@ -50,7 +50,7 @@ class TypedDataTest extends KernelTestBase {
/** /**
* Creates a typed data object and ensures it implements TypedDataInterface. * Creates a typed data object and ensures it implements TypedDataInterface.
* *
* @see \Drupal\Core\TypedData\TypedDataManager::create(). * @see \Drupal\Core\TypedData\TypedDataManager::create()
*/ */
protected function createTypedData($definition, $value = NULL, $name = NULL) { protected function createTypedData($definition, $value = NULL, $name = NULL) {
if (is_array($definition)) { if (is_array($definition)) {

View File

@ -1138,7 +1138,7 @@ function system_sort_modules_by_info_name($a, $b) {
* Callback for uasort() within * Callback for uasort() within
* \Drupal\system\Controller\SystemController::themesPage(). * \Drupal\system\Controller\SystemController::themesPage().
* *
* @see system_sort_modules_by_info_name(). * @see system_sort_modules_by_info_name()
*/ */
function system_sort_themes($a, $b) { function system_sort_themes($a, $b) {
if ($a->is_default) { if ($a->is_default) {

View File

@ -82,7 +82,7 @@ function menu_test_menu_name($new_name = '') {
* @return string * @return string
* A string containing the title and case number. * A string containing the title and case number.
* *
* @see menu_test_menu(). * @see menu_test_menu()
*/ */
function menu_test_title_callback($title, $case_number = 3) { function menu_test_title_callback($title, $case_number = 3) {
return t($title) . ' - Case ' . $case_number; return t($title) . ' - Case ' . $case_number;

View File

@ -69,7 +69,7 @@ function module_test_hook_info() {
/** /**
* Load function used by module_test_hook_dynamic_loading_invoke_all_during_load(). * Load function used by module_test_hook_dynamic_loading_invoke_all_during_load().
* *
* @see module_test_menu(). * @see module_test_menu()
*/ */
function module_test_load($param) { function module_test_load($param) {
$result = \Drupal::moduleHandler()->invokeAll('test_hook'); $result = \Drupal::moduleHandler()->invokeAll('test_hook');

View File

@ -242,7 +242,7 @@ class SystemTestController extends ControllerBase {
/** /**
* Initialize authorize.php during testing. * Initialize authorize.php during testing.
* *
* @see system_authorized_init(). * @see system_authorized_init()
*/ */
public function authorizeInit($page_title) { public function authorizeInit($page_title) {
$authorize_url = Url::fromUri('base:core/authorize.php', array('absolute' => TRUE))->toString(); $authorize_url = Url::fromUri('base:core/authorize.php', array('absolute' => TRUE))->toString();

View File

@ -24,7 +24,7 @@ class TermTranslationHandler extends ContentTranslationHandler {
* *
* This handles the save action. * This handles the save action.
* *
* @see \Drupal\Core\Entity\EntityForm::build(). * @see \Drupal\Core\Entity\EntityForm::build()
*/ */
function entityFormSave(array $form, FormStateInterface $form_state) { function entityFormSave(array $form, FormStateInterface $form_state) {
if ($this->getSourceLangcode($form_state)) { if ($this->getSourceLangcode($form_state)) {

View File

@ -61,7 +61,7 @@ class Toolbar extends RenderElement {
* @return array * @return array
* A renderable array. * A renderable array.
* *
* @see toolbar_page_top(). * @see toolbar_page_top()
*/ */
public static function preRenderToolbar($element) { public static function preRenderToolbar($element) {
// Get the configured breakpoints to switch from vertical to horizontal // Get the configured breakpoints to switch from vertical to horizontal

View File

@ -40,7 +40,7 @@ class ProfileTranslationHandler extends ContentTranslationHandler {
* *
* This handles the save action. * This handles the save action.
* *
* @see \Drupal\Core\Entity\EntityForm::build(). * @see \Drupal\Core\Entity\EntityForm::build()
*/ */
public function entityFormSave(array $form, FormStateInterface $form_state) { public function entityFormSave(array $form, FormStateInterface $form_state) {
if ($this->getSourceLangcode($form_state)) { if ($this->getSourceLangcode($form_state)) {

View File

@ -180,7 +180,7 @@ interface UserInterface extends ContentEntityInterface, EntityChangedInterface,
* @return bool * @return bool
* TRUE if the correct existing password was provided. * TRUE if the correct existing password was provided.
* *
* @see UserInterface::setExistingPassword(). * @see UserInterface::setExistingPassword()
*/ */
public function checkExistingPassword(UserInterface $account_unchanged); public function checkExistingPassword(UserInterface $account_unchanged);

View File

@ -13,7 +13,7 @@ trait BrokenHandlerTrait {
/** /**
* Returns this handlers name in the UI. * Returns this handlers name in the UI.
* *
* @see \Drupal\views\Plugin\views\PluginBase::defineOptions(). * @see \Drupal\views\Plugin\views\PluginBase::defineOptions()
*/ */
public function adminLabel($short = FALSE) { public function adminLabel($short = FALSE) {
return t('Broken/missing handler'); return t('Broken/missing handler');
@ -22,7 +22,7 @@ trait BrokenHandlerTrait {
/** /**
* The option definition for this handler. * The option definition for this handler.
* *
* @see \Drupal\views\Plugin\views\PluginBase::defineOptions(). * @see \Drupal\views\Plugin\views\PluginBase::defineOptions()
*/ */
public function defineOptions() { public function defineOptions() {
return array(); return array();
@ -32,7 +32,7 @@ trait BrokenHandlerTrait {
* Ensure the main table for this handler is in the query. This is used * Ensure the main table for this handler is in the query. This is used
* a lot. * a lot.
* *
* @see \Drupal\views\Plugin\views\HandlerBase::ensureMyTable(). * @see \Drupal\views\Plugin\views\HandlerBase::ensureMyTable()
*/ */
public function ensureMyTable() { public function ensureMyTable() {
// No table to ensure. // No table to ensure.
@ -48,7 +48,7 @@ trait BrokenHandlerTrait {
/** /**
* Provides a form to edit options for this plugin. * Provides a form to edit options for this plugin.
* *
* @see \Drupal\views\Plugin\views\PluginBase::defineOptions(). * @see \Drupal\views\Plugin\views\PluginBase::defineOptions()
*/ */
public function buildOptionsForm(&$form, FormStateInterface $form_state) { public function buildOptionsForm(&$form, FormStateInterface $form_state) {
$description_top = t('The handler for this item is broken or missing. The following details are available:'); $description_top = t('The handler for this item is broken or missing. The following details are available:');
@ -84,7 +84,7 @@ trait BrokenHandlerTrait {
* *
* This means it's a placeholder used when a handler can't be found. * This means it's a placeholder used when a handler can't be found.
* *
* @see \Drupal\views\Plugin\views\HandlerBase::broken(). * @see \Drupal\views\Plugin\views\HandlerBase::broken()
*/ */
public function broken() { public function broken() {
return TRUE; return TRUE;
@ -95,7 +95,7 @@ trait BrokenHandlerTrait {
* *
* @return array * @return array
* *
* @see \Drupal\views\Plugin\views\PluginBase::calculateDependencies(). * @see \Drupal\views\Plugin\views\PluginBase::calculateDependencies()
*/ */
public function calculateDependencies() { public function calculateDependencies() {
return []; return [];

View File

@ -1206,7 +1206,7 @@ abstract class ArgumentPluginBase extends HandlerBase implements CacheableDepend
* @return string * @return string
* The sanitized identifier. * The sanitized identifier.
* *
* @see decodeValidatorId(). * @see decodeValidatorId()
*/ */
public static function encodeValidatorId($id) { public static function encodeValidatorId($id) {
return str_replace(':', '---', $id); return str_replace(':', '---', $id);

View File

@ -21,7 +21,7 @@ class TestHelperPlugin extends PluginBase {
/** /**
* Calls the protected method setOptionDefaults(). * Calls the protected method setOptionDefaults().
* *
* @see \Drupal\views\Plugin\views\PluginBase::setOptionDefaults(). * @see \Drupal\views\Plugin\views\PluginBase::setOptionDefaults()
*/ */
public function testSetOptionDefaults(&$storage, $options, $level = 0) { public function testSetOptionDefaults(&$storage, $options, $level = 0) {
$this->setOptionDefaults($storage, $options, $level); $this->setOptionDefaults($storage, $options, $level);

View File

@ -193,7 +193,7 @@ class BasicTest extends WizardTestBase {
/** /**
* Tests default plugin values are populated from the wizard form. * Tests default plugin values are populated from the wizard form.
* *
* @see \Drupal\views\Plugin\views\display\DisplayPluginBase::mergeDefaults(). * @see \Drupal\views\Plugin\views\display\DisplayPluginBase::mergeDefaults()
*/ */
public function testWizardDefaultValues() { public function testWizardDefaultValues() {
$random_id = strtolower($this->randomMachineName(16)); $random_id = strtolower($this->randomMachineName(16));

View File

@ -39,7 +39,7 @@ class ViewsBlockTest extends ViewsKernelTestBase {
/** /**
* Tests that ViewsBlock::getMachineNameSuggestion() produces the right value. * Tests that ViewsBlock::getMachineNameSuggestion() produces the right value.
* *
* @see \Drupal\views\Plugin\Block::getmachineNameSuggestion(). * @see \Drupal\views\Plugin\Block::getmachineNameSuggestion()
*/ */
public function testMachineNameSuggestion() { public function testMachineNameSuggestion() {
$plugin_definition = array( $plugin_definition = array(

View File

@ -60,8 +60,6 @@
<exclude name="Drupal.Commenting.FunctionComment.ParamCommentNotCapital"/> <exclude name="Drupal.Commenting.FunctionComment.ParamCommentNotCapital"/>
<exclude name="Drupal.Commenting.FunctionComment.ParamNameNoMatch"/> <exclude name="Drupal.Commenting.FunctionComment.ParamNameNoMatch"/>
<exclude name="Drupal.Commenting.FunctionComment.ReturnCommentIndentation"/> <exclude name="Drupal.Commenting.FunctionComment.ReturnCommentIndentation"/>
<exclude name="Drupal.Commenting.FunctionComment.SeeAdditionalText"/>
<exclude name="Drupal.Commenting.FunctionComment.SeePunctuation"/>
<exclude name="Drupal.Commenting.FunctionComment.TypeHintMissing"/> <exclude name="Drupal.Commenting.FunctionComment.TypeHintMissing"/>
<exclude name="Drupal.Commenting.FunctionComment.VoidReturn"/> <exclude name="Drupal.Commenting.FunctionComment.VoidReturn"/>
</rule> </rule>

View File

@ -286,7 +286,7 @@ class DateTimePlusTest extends UnitTestCase {
* An array of arrays, each containing the input parameters for * An array of arrays, each containing the input parameters for
* DateTimePlusTest::testDates(). * DateTimePlusTest::testDates().
* *
* @see DateTimePlusTest::testDates(). * @see DateTimePlusTest::testDates()
*/ */
public function providerTestDates() { public function providerTestDates() {
return array( return array(
@ -313,7 +313,7 @@ class DateTimePlusTest extends UnitTestCase {
* An array of arrays, each containing the input parameters for * An array of arrays, each containing the input parameters for
* DateTimePlusTest::testDates(). * DateTimePlusTest::testDates().
* *
* @see DateTimePlusTest::testDates(). * @see DateTimePlusTest::testDates()
*/ */
public function providerTestDateArrays() { public function providerTestDateArrays() {
return array( return array(

View File

@ -31,7 +31,7 @@ class JsOptimizerUnitTest extends UnitTestCase {
/** /**
* Provides data for the JS asset cleaning test. * Provides data for the JS asset cleaning test.
* *
* @see \Drupal\Core\Asset\JsOptimizer::clean(). * @see \Drupal\Core\Asset\JsOptimizer::clean()
* *
* @returns array * @returns array
* An array of test data. * An array of test data.
@ -78,7 +78,7 @@ class JsOptimizerUnitTest extends UnitTestCase {
/** /**
* Provides data for the JS asset optimize test. * Provides data for the JS asset optimize test.
* *
* @see \Drupal\Core\Asset\JsOptimizer::optimize(). * @see \Drupal\Core\Asset\JsOptimizer::optimize()
* *
* @returns array * @returns array
* An array of test data. * An array of test data.

View File

@ -14,7 +14,7 @@ class BlockBaseTest extends UnitTestCase {
/** /**
* Tests the machine name suggestion. * Tests the machine name suggestion.
* *
* @see \Drupal\Core\Block\BlockBase::getMachineNameSuggestion(). * @see \Drupal\Core\Block\BlockBase::getMachineNameSuggestion()
*/ */
public function testGetMachineNameSuggestion() { public function testGetMachineNameSuggestion() {
$module_handler = $this->getMock('Drupal\Core\Extension\ModuleHandlerInterface'); $module_handler = $this->getMock('Drupal\Core\Extension\ModuleHandlerInterface');

View File

@ -65,7 +65,7 @@ class ParamConverterManagerTest extends UnitTestCase {
* An array of arrays, each containing the input parameters for * An array of arrays, each containing the input parameters for
* providerTestResolvers::testAddConverter(). * providerTestResolvers::testAddConverter().
* *
* @see ParamConverterManagerTest::testAddConverter(). * @see ParamConverterManagerTest::testAddConverter()
*/ */
public function providerTestAddConverter() { public function providerTestAddConverter() {
$converters[0]['unsorted'] = array( $converters[0]['unsorted'] = array(
@ -108,7 +108,7 @@ class ParamConverterManagerTest extends UnitTestCase {
* An array of arrays, each containing the input parameters for * An array of arrays, each containing the input parameters for
* providerTestResolvers::testGetConverter(). * providerTestResolvers::testGetConverter().
* *
* @see ParamConverterManagerTest::testGetConverter(). * @see ParamConverterManagerTest::testGetConverter()
*/ */
public function providerTestGetConverter() { public function providerTestGetConverter() {
return array( return array(

View File

@ -29,7 +29,7 @@ class DerivativeDiscoveryDecoratorTest extends UnitTestCase {
/** /**
* Tests the getDerivativeFetcher method. * Tests the getDerivativeFetcher method.
* *
* @see \Drupal\Component\Plugin\Discovery\DerivativeDiscoveryDecorator::getDerivativeFetcher(). * @see \Drupal\Component\Plugin\Discovery\DerivativeDiscoveryDecorator::getDerivativeFetcher()
*/ */
public function testGetDerivativeFetcher() { public function testGetDerivativeFetcher() {
$definitions = array(); $definitions = array();

View File

@ -135,7 +135,7 @@ class UserSessionTest extends UnitTestCase {
* *
* @dataProvider providerTestHasPermission * @dataProvider providerTestHasPermission
* *
* @see \Drupal\Core\Session\UserSession::hasPermission(). * @see \Drupal\Core\Session\UserSession::hasPermission()
*/ */
public function testHasPermission($permission, array $sessions_with_access, array $sessions_without_access) { public function testHasPermission($permission, array $sessions_with_access, array $sessions_without_access) {
foreach ($sessions_with_access as $name) { foreach ($sessions_with_access as $name) {