document tokens

[nominatim.git] / lib / TokenPostcode.php

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
 {
  */
 class Postcode
 {

+    /// Database word id, if available.

     public $iId;
     public $iId;

-    // full postcode
+    /// Full nomralized postcode (upper cased).

     public $sPostcode;
     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 = '')
     public $sCountryCode;
 
     public function __construct($iId, $sPostcode, $sCountryCode = '')