svn commit: r985633 - /maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml

[lt...@apache.org]

Author: ltheussl
Date: Sun Aug 15 09:16:28 2010
New Revision: 985633

URL: http://svn.apache.org/viewvc?rev=985633&view=rev
Log:
add faq about links to jxr cross-refs

Modified:
    maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml

Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml?rev=985633&r1=985632&r2=985633&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/fml/faq.fml Sun Aug 15 09:16:28 2010
@@ -38,5 +38,22 @@ under the License.
         </p>
       </answer>
     </faq>
+    <faq id="xref_links">
+      <question>
+        How can I generate links to the JXR cross-referenced source?
+      </question>
+      <answer>
+        <p>
+          First make sure that the <a href="pmd-mojo.html#linkXRef">linkXRef</a> parameter is configured
+          correctly (it is switched on by default).
+        </p>
+        <p>
+          Then, the jxr plugin has to run first so that the links can be picked up by the pmd report.
+          If you run from the command line, use <code>mvn jxr:jxr pmd:pmd</code>, or if you want the
+          reports generated by the site plugin, configure the jxr plugin in your reporting section, see
+          <a href="http://maven.apache.org/plugins/maven-jxr-plugin/usage.html">JXR usage</a>.
+        </p>
+      </answer>
+    </faq>
   </part>
 </faqs>
\ No newline at end of file