mediawiki-extensions-Popups/includes/EventLogging
Thiemo Kreuz bffa3178d5 Clean up PHPDoc documentation tags for constants
Our documentation generator Doxygen is not able to understand @var tags
on constants. A constant is neither a "variable", nor is it possibly to
specify an allowed type for a constant. The type of a constant is strictly
derived from it's value. There is no way to change it, other than changing
the constant itself. There is not much value in repeating the type either.
If it's critical to know the type of a constant (which is a very rare
situation), that should be better explained in the comment.

Doxygen strips all @… tags it does not understand, and renders everything
else as a plain string. This makes it possible to use something like:

/**
 * @const Description…
 */

But this is not different from:

/**
 * Description…
 */

Change-Id: I4531d4f6b2ab2aca7a62f13f10a655f31c4d6a7a
2019-02-26 09:56:07 +01:00
..
EventLogger.php Clean up PHPDoc documentation tags for constants 2019-02-26 09:56:07 +01:00
EventLoggerFactory.php Remove non-helpful auto-generated comments on constructors 2019-01-16 15:34:19 +01:00
MWEventLogger.php Remove non-helpful auto-generated comments on constructors 2019-01-16 15:34:19 +01:00
NullLogger.php Add some more missing @covers tags 2018-12-20 15:31:14 +00:00