From c63aac1c6aed328b03d5b23691271f032c1a3998 Mon Sep 17 00:00:00 2001
From: Tom Copeland <tomcopeland@users.sourceforge.net>
Date: Wed, 10 Sep 2003 14:23:19 +0000
Subject: [PATCH] Applied Vadim's XML escape patch

git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@2245 51baf565-9d33-0410-a72c-fc3788e3496d
---
 pmd/xdocs/credits.xml         |  2 +-
 pmd/xdocs/howtowritearule.xml | 27 ++++++++++++---------------
 2 files changed, 13 insertions(+), 16 deletions(-)

diff --git a/pmd/xdocs/credits.xml b/pmd/xdocs/credits.xml
index c04d0bebc9..349bc0116a 100644
--- a/pmd/xdocs/credits.xml
+++ b/pmd/xdocs/credits.xml
@@ -38,7 +38,7 @@
         </subsection>
         <subsection name="Contributors">
         <ul>
-            <li>Vadim Nasardinov - run.sh cleanup</li>
+            <li>Vadim Nasardinov - xdocs cleanup, run.sh cleanup</li>
             <li>Sreenivasa Viswanadha - grammar cleanup for Ctrl-Z problem</li>
             <li>Sigiswald Madou - bug report</li>
             <li>Dan Tullis - bug report</li>
diff --git a/pmd/xdocs/howtowritearule.xml b/pmd/xdocs/howtowritearule.xml
index 224132860a..3a99265dcd 100644
--- a/pmd/xdocs/howtowritearule.xml
+++ b/pmd/xdocs/howtowritearule.xml
@@ -190,31 +190,28 @@ public class WhileLoopsMustUseBracesRule extends AbstractRule {
     </ul>
         <p>The whole ruleset file should look something like this:</p>
         <source>
-        <![CDATA[
-        <?xml version="1.0"?>
-            <rule name="WhileLoopsMustUseBracesRule"
+
+        &lt;?xml version="1.0"?>
+            &lt;rule name="WhileLoopsMustUseBracesRule"
                   message="Avoid using 'while' statements without curly braces"
                   class="net.sourceforge.pmd.rules.XPathRule">
-              <description>
+              &lt;description>
               Avoid using 'while' statements without using curly braces
-              </description>
-                <priority>3</priority>
-
-              <example>
+              &lt;/description>
+                &lt;priority>3&lt;/priority>
 
+              &lt;example>
+        &lt;![CDATA[
             public void doSomething() {
               while (true)
                   x++;
             }
+        ]]&gt;
+              &lt;/example>
+            &lt;/rule>
+        &lt;/ruleset>
 
-              </example>
-            </rule>
-        </ruleset>
-        ]]>
         </source>
-        <p>OK, well, it won't look exactly like that - you'll need to wrap
-        the example in a CDATA tag.  But I couldn't figure out how to do that without Maven getting confused.
-            If you know how to do this, please let me know.</p>
     </subsection>
 
     <subsection name="Run PMD using your new ruleset">