Author: sebb
Date: Wed Jan 21 16:45:26 2015
New Revision: 1653592
URL: http://svn.apache.org/r1653592
Log:
Using markup in code confuses CMS
Modified:
commons/cms-site/trunk/content/xdoc/releases/prepare.xml
Modified: commons/cms-site/trunk/content/xdoc/releases/prepare.xml
URL:
http://svn.apache.org/viewvc/commons/cms-site/trunk/content/xdoc/releases/prepare.xml?rev=1653592&r1=1653591&r2=1653592&view=diff
==============================================================================
--- commons/cms-site/trunk/content/xdoc/releases/prepare.xml (original)
+++ commons/cms-site/trunk/content/xdoc/releases/prepare.xml Wed Jan 21
16:45:26 2015
@@ -156,20 +156,20 @@
If the code is targetted at Java 7 or before, check that the Javadoc can
still be created using Javadoc 8.
Javadoc 8 is a lot stricter about the syntax. Ideally fix all the syntax
errors. However if this is not
feasible in the time-scale, consider adding a temporary profile to the pom
to disable the stricter checking:
- <code>
- <profile>
- <!-- Temporary hack to suppress Javadoc 8 errors -->
- <!-- to re-enable the checks, build with -P-javadoc_8 -->
- <id>javadoc_8</id>
- <activation>
- <jdk>[1.8,)</jdk>
- </activation>
- <properties>
- <!-- Disable Xdoclint, until JavaDoc issues are fixed -->
- <additionalparam>-Xdoclint:none</additionalparam>
- </properties>
- </profile>
- </code>
+ <pre>
+ <profile>
+ <!-- Temporary hack to suppress Javadoc 8 errors -->
+ <!-- to re-enable the checks, build with -P-javadoc_8 -->
+ <id>javadoc_8</id>
+ <activation>
+ <jdk>[1.8,)</jdk>
+ </activation>
+ <properties>
+ <!-- Disable Xdoclint, until JavaDoc issues are fixed -->
+ <additionalparam>-Xdoclint:none</additionalparam>
+ </properties>
+ </profile>
+ </pre>
</p>
<p>
If the component uses checkstyle, findbugs or PMD tools, examine the
reports and fix all