Project

General

Profile

Bug #7093

Remove /** Code */ in all PHP files.

Added by Julio Montoya about 7 years ago. Updated about 7 years ago.

Status:
Needs more info
Priority:
Normal
Category:
Classes
Target version:
Start date:
22/04/2014
Due date:
% Done:

0%

Estimated time:
Complexity:
Normal
SCRUM pts - complexity:
?

Description

I remember I talked with Yannick about this but I don't remember why we need to add this in all the PHP files.

/**
 * Code
 */

History

#1

Updated by Yannick Warnier about 7 years ago

It was (I don't know if it is still) a PHPDoc requirement to have a file-level documentation block and at least one code-level documentation block. We put that marker when we don't know what else to write to have the first (or second) code-level block in the script.
Usually, the first code-level block is something like /** Initialization **/ or soething like that.

Apparently this is not the case anymore: http://phpdoc.org/docs/latest/getting-started/your-first-set-of-documentation.html but it should be checked with the phpdoc compiler (which usually takes more than 4GB of RAM and more than an hour to generate the required documentation, so it is not that simple to check), which usually shouted a very large number of warnings for not having file-level blocks.

I'll try to generate it some time soon so we know for sure.

Also available in: Atom PDF