buildframework/helium/tools/release/release.ant.xml
changeset 217 0f5e3a7fb6af
parent 1 be27ed110b50
child 588 c7c26511138f
--- a/buildframework/helium/tools/release/release.ant.xml	Fri Feb 05 11:59:41 2010 +0000
+++ b/buildframework/helium/tools/release/release.ant.xml	Thu Mar 04 15:10:37 2010 +0200
@@ -20,10 +20,46 @@
 
 ============================================================================
 -->
+<!--* @package releases -->
 <project name="release" xmlns:hlm="http://www.nokia.com/helium">
     <description>
         Release publising.
     </description>
+    
+    <!--* @property release.grace.service
+    The Grace service used
+    @type string
+    @editable required
+    @scope public
+    -->
+
+    <!--* @property release.grace.product
+    The Grace product used
+    @type string
+    @editable required
+    @scope public
+    -->
+
+    <!--* @property release.grace.mail.to
+    To whom the completion mail is sent to
+    @type string
+    @editable required
+    @scope public
+    -->
+
+    <!--* @property release.grace.mail.subject
+    The subject of the Grace upload completion mail
+    @type string
+    @editable required
+    @scope public
+    -->
+
+    <!--* @property release.grace.mail.message
+    The message contents of the Grace upload completion mail
+    @type string
+    @editable required
+    @scope public
+    -->
 
     <fileset id="release.files" dir="${publish.dir}">
         <include name="logs/**/*" />
@@ -43,6 +79,20 @@
         </copy>
     </target>
 
+    <!--* @property s60.build.robot.path
+    Location where to publish the build robot delivery.
+    @type string
+    @editable required
+    @scope public
+    -->
+
+    <!--* @property s60.build.robot.date
+    This property represent the releasing interval. The syntax is as follow: day1,time1,day2,time2,projectname;day1,time1,day2,time2,projectname2 With day and time matching the following properties: day [1, 14] time [00, 23]:[00, 59] Example: 2,10:00,3,20:00,ABS_domain
+    @type string
+    @editable required
+    @scope public
+    -->
+
     <!--
         This target sets the '''do.robot.release''' property so it activates 
         the '''ido-sources-to-s60-build-robot''' target.
@@ -79,6 +129,10 @@
     property to tell the location of the build server which is "s60.build.robot.path".
     -->
     <target name="ido-sources-to-s60-build-robot" if="do.robot.release" depends="ido-create-ado-mapping,check-robot-release,lookup-email">
+        <!-- Location of the ready.txt FMPP template (override that property if you want to customize the content).
+        @type string
+        @scope private
+        -->
         <property name="ido.template.robot.ready" location="${helium.dir}/tools/common/templates/ido/ready.txt.ftl" />
         <tempfile property="s60robot.dynamic.config" suffix=".xml" deleteonexit="false" destdir="${temp.build.dir}" />
         <fmpp sourceFile="${helium.dir}/tools/common/templates/ido/ido-robot-zip.ant.xml.ftl" outputFile="${s60robot.dynamic.config}">