Documentation for ccm-cms-assets-notes.ftl

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

ccm-cms-assets-notes/web/themes/freemarker/ccm-cms-assets-notes.ftl

@@ -5,6 +5,21 @@
 "ui": "http://www.arsdigita.com/ui/1.0"}
 >
 
+<#--filedoc
+    Functions for processing note attachments.
+-->
+
+<#--doc
+    Generates a sorted sequence of hashes (see Freemarker documentation) for 
+    the note attachments of a content item.
+
+    @param item The model of the content item to use.
+
+    @return A sorted sequence of note attachments of the provided content item.
+    The following keys are available in each hash:
+    * `content`: The content of the note.
+    * `rank`: The sort key of the note.
+-->
 <#function getNotes item>
     <#--  <#return item["./ca_notes"]>  -->
     <#return item["./ca_notes"]?map(