Problem/Motivation
Several Twig template docblocks in core use the @see annotation without a space before the referenced class.
@see\Drupal\Core\Form\FormPreprocess::preprocessInput()
According to standard PHPDoc formatting (followed by Drupal coding standards), there should be a space between the annotation and its value.
@see \Drupal\Core\Form\FormPreprocess::preprocessInput()
While this does not affect runtime behavior, without the space @see tags are not correctly parsed by the API module.
Steps to reproduce
Run the following command from the Drupal root:
grep -rni '@see\\Drupal' core/modules
This will return multiple occurrences in Twig template files, for example:
core/modules/system/templates/input.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessInput()
core/modules/system/templates/form-element-label.html.twig:12: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElementLabel()
core/modules/system/templates/vertical-tabs.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessVerticalTabs()
core/modules/system/templates/fieldset.html.twig:26: * @see\Drupal\Core\Form\FormPreprocess::preprocessFieldset()
core/modules/system/templates/form.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessForm()
core/modules/system/templates/checkboxes.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessCheckboxes()
core/modules/system/templates/textarea.html.twig:13: * @see\Drupal\Core\Form\FormPreprocess::preprocessTextarea()
core/modules/system/templates/details.html.twig:15: * @see\Drupal\Core\Form\FormPreprocess::preprocessDetails()
core/modules/system/templates/select.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessSelect()
core/modules/system/templates/form-element.html.twig:44: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElement()
core/modules/system/templates/radios.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessRadios()
core/modules/field_ui/templates/form-element--new-storage-type.html.twig:16: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElement()
core/modules/views/tests/themes/views_test_theme/templates/input--submit.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessInput()
grep -rni '@see\\Drupal' core/themes
core/themes/stable9/templates/form/input.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessInput()
core/themes/stable9/templates/form/form-element-label.html.twig:12: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElementLabel()
core/themes/stable9/templates/form/fieldset.html.twig:26: * @see\Drupal\Core\Form\FormPreprocess::preprocessFieldset()
core/themes/stable9/templates/form/form.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessForm()
core/themes/stable9/templates/form/checkboxes.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessCheckboxes()
core/themes/stable9/templates/form/textarea.html.twig:13: * @see\Drupal\Core\Form\FormPreprocess::preprocessTextarea()
core/themes/stable9/templates/form/details.html.twig:15: * @see\Drupal\Core\Form\FormPreprocess::preprocessDetails()
core/themes/stable9/templates/form/select.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessSelect()
core/themes/stable9/templates/form/form-element.html.twig:44: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElement()
core/themes/stable9/templates/form/radios.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessRadios()
core/themes/stable9/templates/admin/form-element--new-storage-type.html.twig:16: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElement()
core/themes/stable9/templates/navigation/vertical-tabs.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessVerticalTabs()
core/themes/claro/templates/form/input.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessInput()
core/themes/claro/templates/form/checkboxes.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessCheckboxes()
core/themes/claro/templates/form/textarea.html.twig:13: * @see\Drupal\Core\Form\FormPreprocess::preprocessTextarea()
core/themes/claro/templates/form/radios.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessRadios()
core/themes/claro/templates/form-element-label.html.twig:12: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElementLabel()
core/themes/claro/templates/datetime-wrapper.html.twig:6: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElement()
core/themes/claro/templates/fieldset.html.twig:25: * @see\Drupal\Core\Form\FormPreprocess::preprocessFieldset()
core/themes/claro/templates/navigation/details--vertical-tabs.html.twig:19: * @see\Drupal\Core\Form\FormPreprocess::preprocessDetails()
core/themes/claro/templates/media-library/fieldset--media-library-widget.html.twig:9: * @see\Drupal\Core\Form\FormPreprocess::preprocessFieldset()
core/themes/claro/templates/media-library/details--media-library-add-form-selected-media.html.twig:8: * @see\Drupal\Core\Form\FormPreprocess::preprocessDetails()
core/themes/claro/templates/details.html.twig:18: * @see\Drupal\Core\Form\FormPreprocess::preprocessDetails()
core/themes/claro/templates/form-element.html.twig:6: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElement()
core/themes/default_admin/templates/form/input.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessInput()
core/themes/default_admin/templates/form/form-element-label.html.twig:12: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElementLabel()
core/themes/default_admin/templates/form/textarea.html.twig:13: * @see\Drupal\Core\Form\FormPreprocess::preprocessTextarea()
core/themes/default_admin/templates/form/radios.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessRadios()
core/themes/default_admin/templates/navigation/details--vertical-tabs.html.twig:19: * @see\Drupal\Core\Form\FormPreprocess::preprocessDetails()
core/themes/default_admin/templates/media-library/fieldset--media-library-widget.html.twig:9: * @see\Drupal\Core\Form\FormPreprocess::preprocessFieldset()
core/themes/default_admin/templates/media-library/details--media-library-add-form-selected-media.html.twig:8: * @see\Drupal\Core\Form\FormPreprocess::preprocessDetails()
core/themes/starterkit_theme/templates/form/input.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessInput()
core/themes/starterkit_theme/templates/form/form-element-label.html.twig:12: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElementLabel()
core/themes/starterkit_theme/templates/form/fieldset.html.twig:26: * @see\Drupal\Core\Form\FormPreprocess::preprocessFieldset()
core/themes/starterkit_theme/templates/form/form.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessForm()
core/themes/starterkit_theme/templates/form/checkboxes.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessCheckboxes()
core/themes/starterkit_theme/templates/form/textarea.html.twig:13: * @see\Drupal\Core\Form\FormPreprocess::preprocessTextarea()
core/themes/starterkit_theme/templates/form/details.html.twig:15: * @see\Drupal\Core\Form\FormPreprocess::preprocessDetails()
core/themes/starterkit_theme/templates/form/select.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessSelect()
core/themes/starterkit_theme/templates/form/form-element.html.twig:44: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElement()
core/themes/starterkit_theme/templates/form/radios.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessRadios()
core/themes/starterkit_theme/templates/navigation/vertical-tabs.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessVerticalTabs()
core/themes/olivero/templates/form/fieldset.html.twig:28: * @see\Drupal\Core\Form\FormPreprocess::preprocessFieldset()
core/themes/olivero/templates/form/input--submit--header-search.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessInput()
core/themes/olivero/templates/form/details.html.twig:15: * @see\Drupal\Core\Form\FormPreprocess::preprocessDetails()
core/themes/olivero/templates/datetime-wrapper.html.twig:6: * @see\Drupal\Core\Form\FormPreprocess::preprocessFormElement()
core/themes/olivero/templates/form--search-block-form.html.twig:10: * @see\Drupal\Core\Form\FormPreprocess::preprocessForm()
Proposed resolution
Update all occurrences of @see\Drupal to include a space after @see:
- * @see\Drupal\Core\Form\FormPreprocess::preprocessInput()
+ * @see \Drupal\Core\Form\FormPreprocess::preprocessInput()
This aligns the docblocks with PHPDoc standards and Drupal coding conventions.
Remaining tasks
- Identify all occurrences in core Twig templates
- Add a space after
@see, if there are no spaces after that tag