Improve documentation of constants throughout the codebase
authorThiemo Kreuz <thiemo.kreuz@wikimedia.de>
Tue, 26 Feb 2019 13:02:50 +0000 (14:02 +0100)
committerThiemo Kreuz <thiemo.kreuz@wikimedia.de>
Tue, 26 Feb 2019 13:02:50 +0000 (14:02 +0100)
commit18741b93060ec6d60da860da2e48894dd42002cd
treed9f52261dd4e1ad9ded0c62e6a35798b0b428b8c
parentf8efd21621ad59ed373102f6a332f3f31bdeab6f
Improve documentation of constants throughout the codebase

The most notable improvements I was able to fit into this patch can be
seen in the User class, as well as in AbstractRestriction.

Our documentation generator ignores the @const tag. It's not needed. Just
have a comment above a constant and it will show up in the generated
documentation.

Using @var is misleading because a constant is not a "variable". The type
of a constant is strictly derived from it's value. Documenting the type
typically does not provide useful information. Doxygen does not understand
the type, but ignores any @… tag and renders everything else as plain text.

I can split this patch if you prefer. Please tell me.

Change-Id: I8019ae45c049822cdc1768d895ea3e3216c6db5f
includes/MergeHistory.php
includes/block/Restriction/AbstractRestriction.php
includes/block/Restriction/Restriction.php
includes/media/DjVuImage.php
includes/search/SearchEngine.php
includes/search/SearchResultSet.php
includes/user/User.php
includes/watcheditem/NoWriteWatchedItemStore.php