document tokens

diff --git a/lib/TokenCountry.php b/lib/TokenCountry.php
index 1b545882142cfe6465ecc5067412e283f36c0bc3..518c0a31e3df225c37a19073946dd6c0dfd11035 100644 (file)
--- a/lib/TokenCountry.php
+++ b/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)

diff --git a/lib/TokenHousenumber.php b/lib/TokenHousenumber.php
index 788b73049812bbfce7e191a8ebb2efc26cfe5031..5c7c6e9b633a4af458acbc637249ffad2453f7ac 100644 (file)
--- a/lib/TokenHousenumber.php
+++ b/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)

diff --git a/lib/TokenPostcode.php b/lib/TokenPostcode.php
index b4bdbfc4535ff91fc1004fc1dae6ee30c229d0bd..8fa2ae8021d1bfbed459fb0c546d379271f1188c 100644 (file)
--- a/lib/TokenPostcode.php
+++ b/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 = '')

diff --git a/lib/TokenSpecialTerm.php b/lib/TokenSpecialTerm.php
index d2a21721aacb95a7c113d577900a36af71e803dc..46966a8a1bed1e22ec8096bd700f2e2039856cf1 100644 (file)
--- a/lib/TokenSpecialTerm.php
+++ b/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)

diff --git a/lib/TokenWord.php b/lib/TokenWord.php
index 92940c104a07d06fc4274bdf4cd5390640688a30..54622cbcb081c05cd3bd3b67d663ef938455763c 100644 (file)
--- a/lib/TokenWord.php
+++ b/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)