As per the revised coding standards @file docblock has no use anymore.

We still need @file in .module and .install files, as well as theme templates.
The only @file doc blocks to remove would be for files under (modulename)/src -- the PSR-4-compliant class/interface files.

CommentFileSizeAuthor
#2 2843936-file-tag-remove-2.patch2.1 KBashish-deynap

Comments

ashish-deynap created an issue. See original summary.

ashish-deynap’s picture

StatusFileSize
new2.1 KB

I removed @file docblock from following files:

config_tools/config_files/src/ConfigFilesSettingsForm.php
config_tools/config_files/src/FileConfigEvents.php
config_tools/config_logging/src/ConfigLoggingStorage.php
config_tools/config_logging/src/LogConfigChanges.php
config_tools/git_config/src/GitConfigEvents.php
config_tools/git_config/src/GitConfigSettingsForm.php

ashish-deynap’s picture

Status: Active » Needs review
ashish-deynap’s picture

Title: Removing @file doc comment in views rss » Removing @file doc comment in Configuration Tools
avpaderno’s picture

Title: Removing @file doc comment in Configuration Tools » Removing the @file tag from the files containing a class, an interface, or a trait
Version: 8.x-1.0-alpha3 » 8.x-1.x-dev
Assigned: ashish-deynap » Unassigned
Category: Bug report » Task
Status: Needs review » Closed (outdated)
Issue tags: -PSR-4 +Coding standards

This has been fixed with commit f1b69a1, when the code has been replaced with code from another repository.

avpaderno’s picture

Title: Removing the @file tag from the files containing a class, an interface, or a trait » Remove the @file tag from the files containing a class, an interface, or a trait