Docuementation for ccm-cms-types-contact.ftt

git-svn-id: https://svn.libreccm.org/ccm/trunk@6298 8810af33-2d31-482b-a856-94f89814c4df

ccm-cms-types-contact/web/themes/freemarker/ccm-cms-types-contact.ftl

@@ -5,30 +5,85 @@
 "ui": "http://www.arsdigita.com/ui/1.0"}
 >
 
+<#--filedoc
+    Functions for processing contact items.
+-->
+
+<#--doc
+    Gets the address associated with the provided contact item.
+
+    @param item The model of the contact item to use.
+
+    @return The model of the address item associated with the contact item.
+-->
 <#function getAddress item>
     <#return item["./address"]>
 </#function>
 
+<#--doc
+    Gets the person associated with the provided contact item.
+
+    @param item The model of the contact item to use.
+
+    @return The model of the person item associated with the contact item.
+-->
 <#function getPerson item>
     <#return item["./person"]>
 </#function>
 
+<#--doc
+    Gets the contact entries of the provided contact item.
+
+    @param item The model of the contact item to use.
+
+    @return A sequence of the models of the contact entries of the contact item.
+-->
 <#function getContactEntries item>
     <#return item["./contactentries"]>
 </#function>
 
+<#--doc
+    Gets the specific contact entry by its `keyId`.
+
+    @param item The model of the contact item to use.
+
+    @param keyId The ID of the entry to retrieve.
+
+    @return The model of the contact entry with the provided ID.
+-->
 <#function getContactEntry item keyId>
     <#return item["./contactentries[keyId='${keyId}']"]>
 </#function>
 
+<#--doc
+    Gets the label of a contact entry.
+
+    @param entry The model of the contact entry to use.
+
+    @return The label of the contact entry.
+-->
 <#function getContactEntryLabel entry>
     <#return entry["./key"]>
 </#function>
 
+<#--doc
+    Gets the key of a contact entry.
+
+    @param entry The model of the contact entry to use.
+
+    @return The key of the contact entry.
+-->
 <#function getContactEntryKey entry>
     <#return entry["./key"]>
 </#function>
 
+<#--doc
+    Gets the value of a contact entry.
+
+    @param entry The model of the contact entry to use.
+
+    @return The value of the contact entry.
+-->
 <#function getContactEntryValue entry>
     <#return entry["./value"]>
 </#function>