Merge "Improve documentation of constants throughout the codebase"

[lhc/web/wiklou.git] / includes / block / Restriction / AbstractRestriction.php

diff --git a/includes/block/Restriction/AbstractRestriction.php b/includes/block/Restriction/AbstractRestriction.php
index 7970266..a010e83 100644 (file)
--- a/includes/block/Restriction/AbstractRestriction.php
+++ b/includes/block/Restriction/AbstractRestriction.php
@@ -25,12 +25,14 @@ namespace MediaWiki\Block\Restriction;
 abstract class AbstractRestriction implements Restriction {
 
        /**
-        * @var string
+        * String constant identifying the type of restriction. Expected to be overriden in subclasses
+        * with a non-empty string value.
         */
        const TYPE = '';
 
        /**
-        * @var int
+        * Numeric type identifier. Expected to be overriden in subclasses with a non-zero integer
+        * number. Must not exceed 127 to fit into a TINYINT database field.
         */
        const TYPE_ID = 0;