document tokens

lib/TokenCountry.php

@@ -7,7 +7,9 @@ namespace Nominatim\Token;
  */
 class Country
 {
+    /// Database word id, if available.
     public $iId;
+    /// Two-letter country code (lower-cased).
     public $sCountryCode;
 
     public function __construct($iId, $sCountryCode)

lib/TokenHousenumber.php

@@ -7,7 +7,9 @@ namespace Nominatim\Token;
  */
 class HouseNumber
 {
+    /// Database word id, if available.
     public $iId;
+    /// Normalized house number.
     public $sToken;
 
     public function __construct($iId, $sToken)

lib/TokenPostcode.php

@@ -7,10 +7,11 @@ namespace Nominatim\Token;
  */
 class Postcode
 {
+    /// Database word id, if available.
     public $iId;
-    // full postcode
+    /// Full nomralized postcode (upper cased).
     public $sPostcode;
-    // optional restriction to a given country
+    // Optional country code the postcode belongs to (currently unused).
     public $sCountryCode;
 
     public function __construct($iId, $sPostcode, $sCountryCode = '')

lib/TokenSpecialTerm.php

@@ -9,9 +9,13 @@ require_once(CONST_BasePath.'/lib/SpecialSearchOperator.php');
  */
 class SpecialTerm
 {
+    /// Database word id, if applicable.
     public $iId;
+    /// Class (or OSM tag key) of the place to look for.
     public $sClass;
+    /// Type (or OSM tag value) of the place to look for.
     public $sType;
+    /// Relationship of the operator to the object (see Operator class).
     public $iOperator;
 
     public function __construct($iID, $sClass, $sType, $iOperator)

lib/TokenWord.php

@@ -7,10 +7,11 @@ namespace Nominatim\Token;
  */
 class Word
 {
+    /// Database word id, if applicable.
     public $iId;
-    // If true, the word may represent only part of a place name.
+    /// If true, the word may represent only part of a place name.
     public $bPartial;
-    // Number of appearances in the database.
+    /// Number of appearances in the database.
     public $iSearchNameCount;
 
     public function __construct($iId, $bPartial, $iSearchNameCount)