document tokens

[nominatim.git] / lib / TokenSpecialTerm.php

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)