# HG changeset patch
# User Dmitry Neverov <dmitry.neverov@gmail.com>
# Date 1491381389 -7200
# Node ID 075f3521bd029a8824306faabd9451bb88677a14
# Parent  1aaf8dba4072592e5d3ae7117d4e364f7d701c0f
documenting dsl

diff -r 1aaf8dba4072 -r 075f3521bd02 mercurial-dsl/HgVcsRoot.xml
--- a/mercurial-dsl/HgVcsRoot.xml	Tue Feb 21 18:22:37 2017 +0100
+++ b/mercurial-dsl/HgVcsRoot.xml	Wed Apr 05 10:36:29 2017 +0200
@@ -16,27 +16,105 @@
   -->
 
 <dsl-extension kind="vcs" type="mercurial" generateDslJar="true">
-  <class name="HgVcsRoot"/>
+  <class name="HgVcsRoot">
+    <description>
+      Mercurial [VCS root](https://confluence.jetbrains.com/display/TCDL/Mercurial)
+    </description>
+  </class>
   <params>
-    <param name="repositoryPath" dslName="url"/>
-    <param name="branchName" dslName="branch"/>
-    <param name="teamcity:branchSpec" dslName="branchSpec"/>
-    <param name="useTagsAsBranches" type="boolean"/>
-    <param name="detectSubrepoChanges" type="boolean"/>
-    <param name="tagUsername" dslName="userForTags"/>
-    <param name="uncompressedTransfer" type="boolean"/>
-    <param name="hgCommandPath" dslName="hgPath"/>
-    <param name="customHgConfig"/>
-    <param name="username" dslName="userName"/>
-    <param name="secure:password" dslName="password"/>
-    <param name="purgePolicy" type="PurgePolicy"/>
-    <param name="useSharedMirrors" dslName="useMirrors" type="boolean"/>
+    <param name="repositoryPath" dslName="url">
+      <description>
+        Mercurial repository URL
+      </description>
+    </param>
+    <param name="branchName" dslName="branch">
+      <description>
+        Default branch name
+      </description>
+    </param>
+    <param name="teamcity:branchSpec" dslName="branchSpec">
+      <description>
+        [Branch specification](https://confluence.jetbrains.com/display/TCDL/Working+with+Feature+Branches#WorkingwithFeatureBranches-branchSpec)
+        to use in VCS root
+      </description>
+    </param>
+    <param name="useTagsAsBranches" type="boolean">
+      <description>
+        Allows to use tags in branch specification. By default, tags are ignored.
+      </description>
+    </param>
+    <param name="detectSubrepoChanges" type="boolean">
+      <description>
+        Whether TeamCity should detect changes in submodules
+      </description>
+    </param>
+    <param name="tagUsername" dslName="userForTags">
+      <description>
+        A custom username for tags. Format: User Name &lt;email&gt;
+      </description>
+    </param>
+    <param name="uncompressedTransfer" type="boolean">
+      <description>
+        Whether the "--uncompressed" option should be added to the "hg clone" command.
+        It is enabled by default.
+      </description>
+    </param>
+    <param name="hgCommandPath" dslName="hgPath">
+      <description>
+        [Path](https://confluence.jetbrains.com/display/TCDL/Mercurial#Mercurial-hgDetection) to hg executable
+      </description>
+    </param>
+    <param name="customHgConfig">
+      <description>
+        Mercurial configuration options to be applied to the repository in the
+        standard [format](https://www.selenic.com/mercurial/hgrc.5.html)
+      </description>
+    </param>
+    <param name="username" dslName="userName">
+      <description>
+        A username for mercurial connection
+      </description>
+    </param>
+    <param name="secure:password" dslName="password">
+      <description>
+        A password for mercurial connection
+      </description>
+    </param>
+    <param name="purgePolicy" type="PurgePolicy">
+      <description>
+        Specifies whether TeamCity should run the [hg purge](https://www.mercurial-scm.org/wiki/PurgeExtension) command and what files should be purged
+        @see PurgePolicy
+      </description>
+    </param>
+    <param name="useSharedMirrors" dslName="useMirrors" type="boolean">
+      <description>
+        When set to true, TeamCity creates a local agent mirror first (under agent's system/mercurial directory) and then clones to the
+        build [checkout directory](https://confluence.jetbrains.com/display/TCDL/Build+Checkout+Directory) from this local mirror.
+        This option speeds up clean checkout, because only the build working directory is cleaned.
+        Also, if a single root is used in several build configurations, a clone will be faster.
+      </description>
+    </param>
   </params>
   <types>
     <enum name="PurgePolicy">
-      <option name="DONT_RUN"/>
-      <option name="PURGE_UNKNOWN"/>
-      <option name="PURGE_ALL"/>
+      <description>
+        Defines [hg purge](https://www.mercurial-scm.org/wiki/PurgeExtension) settings
+      </description>
+      <option name="DONT_RUN">
+        <description>
+          Don't run the "hg purge"
+        </description>
+      </option>
+      <option name="PURGE_UNKNOWN">
+        <description>
+          Purge unknown files and empty directories
+        </description>
+      </option>
+      <option name="PURGE_ALL">
+        <description>
+          Purge unknown files, empty directories, and ignored files. Runs "hg purge --all".
+        </description>
+      </option>
     </enum>
   </types>
 </dsl-extension>
\ No newline at end of file