Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

HV-575: Updating documentation

  • Loading branch information...
commit ae57ecdf487308ca2dfefdc7ad83bce8e3edb2fc 1 parent 948702b
Gunnar Morling gunnarmorling authored hferentschik committed
76 documentation/src/main/docbook/en-US/modules/annotationprocessor.xml
@@ -53,7 +53,7 @@
53 53 the distribution bundle on <ulink
54 54 url="http://sourceforge.net/projects/hibernate/files/hibernate-validator">Sourceforge</ulink>
55 55 or in the JBoss Maven Repository (see <xref
56   - linkend="example-jboss-maven-url" />) under the GAV
  56 + linkend="example-jboss-maven-url"/>) under the GAV
57 57 org.hibernate:hibernate-validator-annotation-processor.</para>
58 58 </note>
59 59
@@ -114,7 +114,7 @@
114 114 controlled using the <ulink
115 115 url="http://java.sun.com/javase/6/docs/technotes/tools/windows/javac.html#options">processor
116 116 options</ulink> listed in table<xref
117   - linkend="table_processor_options" />:</para>
  117 + linkend="table_processor_options"/>:</para>
118 118
119 119 <table id="table_processor_options">
120 120 <title>Hibernate Validator Annotation Processor options</title>
@@ -181,32 +181,17 @@
181 181
182 182 <para>When compiling on the command line using <ulink
183 183 url="http://java.sun.com/javase/6/docs/technotes/guides/javac/index.html">javac</ulink>,
184   - specify the following JARs using the "processorpath" option:</para>
185   -
186   - <itemizedlist>
187   - <listitem>
188   - <para>validation-api-&bvVersion;.jar</para>
189   - </listitem>
190   -
191   - <listitem>
192   - <para>hibernate-validator-&version;.jar</para>
193   - </listitem>
194   -
195   - <listitem>
196   - <para>hibernate-validator-annotation-processor-&version;.jar</para>
197   - </listitem>
198   - </itemizedlist>
199   -
200   - <para>The following listing shows an example. The processor will be
201   - detected automatically by the compiler and invoked during
202   - compilation.</para>
  184 + specify the JAR hibernate-validator-annotation-processor-&version;.jar
  185 + using the "processorpath" option as shown in the following listing.
  186 + The processor will be detected automatically by the compiler and
  187 + invoked during compilation.</para>
203 188
204 189 <example>
205 190 <title>Using the annotation processor with javac</title>
206 191
207 192 <programlisting>javac src/main/java/org/hibernate/validator/ap/demo/Car.java \
208 193 -cp /path/to/validation-api-&bvVersion;.jar \
209   - -processorpath /path/to/validation-api-&bvVersion;.jar:/path/to/hibernate-validator-&version;:/path/to/hibernate-validator-annotation-processor-&version;.jar</programlisting>
  194 + -processorpath /path/to/hibernate-validator-annotation-processor-&version;.jar</programlisting>
210 195 </example>
211 196 </section>
212 197
@@ -226,7 +211,7 @@
226 211 destdir="build/classes"
227 212 classpath="/path/to/validation-api-&bvVersion;.jar"&gt;
228 213 &lt;compilerarg value="-processorpath" /&gt;
229   - &lt;compilerarg value="/path/to/validation-api-&bvVersion;.jar:/path/to/hibernate-validator-&version;:/path/to/hibernate-validator-annotation-processor-&version;.jar"/&gt;
  214 + &lt;compilerarg value="/path/to/hibernate-validator-annotation-processor-&version;.jar"/&gt;
230 215 &lt;/javac&gt;</programlisting>
231 216 </example>
232 217 </section>
@@ -276,7 +261,7 @@
276 261 &lt;/pluginRepository&gt;
277 262 &lt;/pluginRepositories&gt;
278 263 ... </programlisting>
279   - </example> Now disable the standard annotation processing performed
  264 + </example>Now disable the standard annotation processing performed
280 265 by the compiler plugin and configure the annotation plugin by
281 266 specifying an execution and adding the Hibernate Validator Annotation
282 267 Processor as plugin dependency (that way the AP is not visible on the
@@ -349,21 +334,8 @@
349 334
350 335 <listitem>
351 336 <para>Go to "Java Compiler - Annotation Processing - Factory Path"
352   - and add the following JARs:</para>
353   -
354   - <itemizedlist>
355   - <listitem>
356   - <para>validation-api-&bvVersion;.jar</para>
357   - </listitem>
358   -
359   - <listitem>
360   - <para>hibernate-validator-&version;.jar</para>
361   - </listitem>
362   -
363   - <listitem>
364   - <para>hibernate-validator-annotation-processor-&version;.jar</para>
365   - </listitem>
366   - </itemizedlist>
  337 + and add the JAR
  338 + hibernate-validator-annotation-processor-&version;.jar</para>
367 339 </listitem>
368 340
369 341 <listitem>
@@ -377,7 +349,7 @@
377 349 <mediaobject>
378 350 <imageobject>
379 351 <imagedata align="center" arch="" contentwidth="150mm"
380   - fileref="annotation_processor_eclipse.png" />
  352 + fileref="annotation_processor_eclipse.png"/>
381 353 </imageobject>
382 354 </mediaobject>
383 355 </section>
@@ -402,7 +374,7 @@
402 374 <listitem>
403 375 <para>Choose "Enable annotation processing" and enter the
404 376 following as "Processor path":
405   - /path/to/validation-api-&bvVersion;.jar:/path/to/hibernate-validator-&version;.jar:/path/to/hibernate-validator-annotation-processor-&version;.jar</para>
  377 + /path/to/hibernate-validator-annotation-processor-&version;.jar</para>
406 378 </listitem>
407 379
408 380 <listitem>
@@ -423,7 +395,7 @@
423 395 <mediaobject>
424 396 <imageobject>
425 397 <imagedata align="center" arch="" contentwidth="150mm"
426   - fileref="annotation_processor_intellij.png" />
  398 + fileref="annotation_processor_intellij.png"/>
427 399 </imageobject>
428 400 </mediaobject>
429 401 </section>
@@ -442,22 +414,8 @@
442 414 </listitem>
443 415
444 416 <listitem>
445   - <para>Go to "Libraries", tab "Processor", and add the following
446   - JARs:</para>
447   -
448   - <itemizedlist>
449   - <listitem>
450   - <para>validation-api-&bvVersion;.jar</para>
451   - </listitem>
452   -
453   - <listitem>
454   - <para>hibernate-validator-&version;.jar</para>
455   - </listitem>
456   -
457   - <listitem>
458   - <para>hibernate-validator-annotation-processor-&version;.jar</para>
459   - </listitem>
460   - </itemizedlist>
  417 + <para>Go to "Libraries", tab "Processor", and add the JAR
  418 + hibernate-validator-annotation-processor-&version;.jar</para>
461 419 </listitem>
462 420
463 421 <listitem>
@@ -474,7 +432,7 @@
474 432 <mediaobject>
475 433 <imageobject>
476 434 <imagedata align="center" arch="" contentwidth="150mm"
477   - fileref="annotation_processor_netbeans.png" />
  435 + fileref="annotation_processor_netbeans.png"/>
478 436 </imageobject>
479 437 </mediaobject>
480 438 </section>

0 comments on commit ae57ecd

Please sign in to comment.
Something went wrong with that request. Please try again.