svn commit: r811804 - /maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml

[vs...@apache.org]

Author: vsiveton
Date: Sun Sep  6 10:57:27 2009
New Revision: 811804

URL: http://svn.apache.org/viewvc?rev=811804&view=rev
Log:
o using CDATA for <source/>

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

Modified: maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml?rev=811804&r1=811803&r2=811804&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/site/fml/faq.fml Sun Sep  6 10:57:27 2009
@@ -69,10 +69,10 @@
           The Javadoc Plugin calls the Javadoc tool with
           <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#argumentfiles">argument files</a>,
           i.e. files called 'options', 'packages' and 'argfile' (or 'files' with Jdk &lt; 1.4):
-          <source>
+          <source><![CDATA[
 ${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
     @options \
-    @packages | @argfile</source>
+    @packages | @argfile]]></source>
         </p>
         <p>
           These argument files are generated at runtime depending the Javadoc Plugin configuration and are deleted
@@ -107,11 +107,11 @@
         </p>
         <p>
           The Javadoc Plugin calls the Javadoc tool with J options, i.e.:
-          <source>
+          <source><![CDATA[
 ${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
     -J-Xss128m \
     @options \
-    @packages | @argfile</source>
+    @packages | @argfile]]></source>
         </p>
       </answer>
     </faq>
@@ -121,7 +121,7 @@
         <p>
           If you need to increase the Javadoc heap size, you should use the <i>&lt;minmemory/&gt;</i> and
           <i>&lt;maxmemory/&gt;</i> parameters in your Javadoc Plugin configuration. For instance:
-          <source>
+          <source><![CDATA[
 <project>
   ...
   <reporting>
@@ -140,7 +140,7 @@
     ...
   </reporting>
   ...
-</project></source>
+</project>]]></source>
         </p>
         <p>
           <b>Note:</b> The memory unit depends on the JVM used. The units supported could be: <code>k</code>,
@@ -158,7 +158,7 @@
         </p>
         <p>
           The Javadoc Plugin calls the Javadoc tool with networking J options, i.e.:
-          <source>
+          <source><![CDATA[
 ${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
     -J-Dhttp.proxySet=true \
     -J-Dhttp.proxyHost=http://localhost \
@@ -167,7 +167,7 @@
     -J-Dhttp.proxyUser="toto" \
     -J-Dhttp.proxyPassword="toto" \
     @options \
-    @packages | @argfile</source>
+    @packages | @argfile]]></source>
         </p>
       </answer>
     </faq>
@@ -194,7 +194,7 @@
         <p>
           Basically, you need to call <i>mvn clean javadoc:jar deploy</i>. If you want to include the javadoc jar
           in a release process, you need to attach it in the release profile, for instance:
-          <source>
+          <source><![CDATA[
 <project>
   ...
   <profiles>
@@ -220,11 +220,11 @@
     ...
   </profiles>
   ...
-</project></source>
+</project>]]></source>
         </p>
         <p>
           To deploy the Javadoc jar on a given Maven repository, you could call:
-          <source>
+          <source><![CDATA[
 mvn deploy:deploy-file \
     -DgroupId=&lt;group-id&gt; \
     -DartifactId=&lt;artifact-id&gt; \
@@ -233,7 +233,7 @@
     -Dpackaging=jar \
     -DrepositoryId=&lt;repository-id&gt; \
     -Durl=dav:http://www.myrepository.com/m2 \
-    -Dclassifier=javadoc</source>
+    -Dclassifier=javadoc]]></source>
         </p>
       </answer>
     </faq>
@@ -271,7 +271,7 @@
           <a href="javascript:;" onclick="toggleException( '_6219854' );" style="cursor: pointer;vertical-align:text-bottom;">one</a>.
         </p>
         <div id="_6219854" style="display:none">
-          <source>
+          <source><![CDATA[
 ...
 [INFO] ------------------------------------------------------------------------
 [ERROR] BUILD ERROR
@@ -351,7 +351,7 @@
   at com.sun.tools.javadoc.Main.main(Main.java:31)
 
   Command line was:C:\Java\jdk1.6.0_03\jre\..\bin\javadoc.exe @options @packages
-  ...</source>
+  ...]]></source>
         </div>
         <p>
           Your <i>CLASSPATH</i> environement variable is probably corrupted, i.e. something like: