As per coding standard documentation at 'https://www.drupal.org/coding-standards/docs', @file tag docblock should not be there in the files that contain a namespaced class/interface/trait, whose file name is the class name with a .php extension.

CommentFileSizeAuthor
#4 2846526-4.patch14.74 KBdcam
#2 remove@file_2846526_1.patch5.53 KBnehakhadke

Comments

nehakhadke created an issue. See original summary.

nehakhadke’s picture

StatusFileSize
new5.53 KB
dcam’s picture

Status: Needs review » Needs work

Yeah, I know. I just hadn't bothered to make the changes. Thank you for your contribution. Unfortunately, there's one problem.

+++ b/src/Plugin/views/style/RecipeML.php
@@ -1,26 +1,5 @@
- * Copyright (c) FormatData. All rights reserved.
- *
- * Distribution of RecipeML Processing Software in source and/or binary forms is
- * permitted provided that the following conditions are met:
- * - Distributions in source code must retain the above copyright notice and
- *   this list of conditions.
- * - Distributions in binary form must reproduce the above copyright notice and
- *   this list of conditions in the documentation and/or other materials
- *   provided with the distribution.
- * - All advertising materials and documentation for RecipeML Processing
- *   Software must display the following acknowledgment:
- *   "This product is RecipeML compatible."
- * - Names associated with RecipeML or FormatData must not be used to endorse or
- *   promote RecipeML Processing Software without prior written permission from
- *   FormatData. For written permission, please contact RecipeML@formatdata.com.
- */

This licensing information must be included with the file in order to be in compliance. You could remove the needless class info, but I want the license to stay in the @file docblock.

dcam’s picture

StatusFileSize
new14.74 KB

This needed a reroll. Plus, aside from the problem I mentioned in #3 a bunch of other docblocks inside the Ingredient module were not removed.

dcam’s picture

Status: Needs work » Needs review

Changed status for Testbot.

  • dcam committed fc7ccea on 8.x-2.x
    Issue #2846526 by nehakhadke, dcam: Remove @file docblock from PHP...
dcam’s picture

Title: Remove @file tag docblock from all the .php files. » Remove @file docblock from PHP classes
Status: Needs review » Fixed

Committed #4.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.