From 571aa14d4fed8888c552b57f0ae2c4e11b87c160 Mon Sep 17 00:00:00 2001
From: jensp <jensp@8810af33-2d31-482b-a856-94f89814c4df>
Date: Sun, 3 Nov 2019 10:35:03 +0000
Subject: [PATCH] Documentation for ccm-cms-types-address.ftl

git-svn-id: https://svn.libreccm.org/ccm/trunk@6292 8810af33-2d31-482b-a856-94f89814c4df
---
 .../freemarker/ccm-cms-types-address.ftl      | 47 +++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/ccm-cms-types-address/web/themes/freemarker/ccm-cms-types-address.ftl b/ccm-cms-types-address/web/themes/freemarker/ccm-cms-types-address.ftl
index 997dc41d0..29f2ca25c 100644
--- a/ccm-cms-types-address/web/themes/freemarker/ccm-cms-types-address.ftl
+++ b/ccm-cms-types-address/web/themes/freemarker/ccm-cms-types-address.ftl
@@ -5,26 +5,73 @@
 "ui": "http://www.arsdigita.com/ui/1.0"}
 >
 
+<#--filedoc
+    Functions for processing the special properties of content items of the 
+    type address.
+-->
+
+<#--doc
+    Gets the value of the `address` text property of the provided address item.
+
+    @param item The address item to use.
+
+    @return The value of the `address` property of the provided address item.
+-->
 <#function getAddressText item>
     <#return item["./address"]>
 </#function>
 
+<#--doc
+    Gets the value of the `city` property of the provided address item.
+
+    @param item The address item to use.
+
+    @return The value of the `city` property of the provided address item.
+-->
 <#function getCity item>
     <#return item["./city"]>
 </#function>
 
+<#--doc
+    Gets the value of the `postalCode` property of the provided address item.
+
+    @param item The address item to use.
+
+    @return The value of the `postalCode` property of the provided address item.
+-->
 <#function getPostalCode item>
     <#return item["./postalCode"]>
 </#function>
 
+<#--doc
+    Gets the value of the `state` property of the provided address item.
+
+    @param item The address item to use.
+
+    @return The value of the `state` property of the provided address item.
+-->
 <#function getState item>
     <#return item["./state"]>
 </#function>
 
+<#--doc
+    Gets the value of the `country` property of the provided address item.
+
+    @param item The address item to use.
+
+    @return The value of the `country` property of the provided address item.
+-->
 <#function getCountry item>
     <#return item["./country"]>
 </#function>
 
+<#--doc
+    Gets the value of the `isoCountryCode` property of the provided address item.
+
+    @param item The address item to use.
+
+    @return The value of the `isoCountryCode` property of the provided address item.
+-->
 <#function getIsoCountryCode item>
     <#return item["./isoCountryCode"]>
 </#function>
\ No newline at end of file