|
16 | 16 | trigger special handling based on the keyword.</para> |
17 | 17 |
|
18 | 18 | <para>The "special handling" is controlled by an instance of |
19 | | - <see cref="IPlaceholderHandler"/> per keyword. The class <see |
20 | | - cref="PlaceholderDifferenceEvaluator"/> loads all |
21 | | - implementations from the current assembly via reflection.</para> |
| 19 | + <c>IPlaceholderHandler</c> per keyword. The class |
| 20 | + <c>PlaceholderDifferenceEvaluator</c> loads all implementations |
| 21 | + from the current assembly via reflection.</para> |
22 | 22 |
|
23 | 23 | <para>The placeholder sequence can take any number of string |
24 | 24 | values as arguments in the form |
|
31 | 31 |
|
32 | 32 | <para>Keywords currently supported by built-in handlers |
33 | 33 | are:</para> |
34 | | - <list type="bullet"> |
| 34 | + <list type="table"> |
35 | 35 |
|
36 | | - <item><c>${xmlunit.ignore}</c> which makes XMLUnit ignore the |
37 | | - nested text or attribute completely. This is handled by <see |
38 | | - cref="IgnorePlaceholderHandler"/>.</item> |
| 36 | + <item><term><c>${xmlunit.ignore}</c></term> <description>which |
| 37 | + makes XMLUnit ignore the nested text or attribute |
| 38 | + completely. This is handled by |
| 39 | + <c>IgnorePlaceholderHandler</c>.</description></item> |
39 | 40 |
|
40 | | - <item><c>${xmlunit.isNumber}</c> makes the comparison pass if |
41 | | - the textual content of the element or attributes looks like a |
42 | | - number. This is handled by <see |
43 | | - cref="IsNumberPlaceholderHandler"/>.</item> |
| 41 | + <item><term><c>${xmlunit.isNumber}</c></term> <description> |
| 42 | + makes the comparison pass if the textual content of the |
| 43 | + element or attributes looks like a number. This is handled by |
| 44 | + <c>IsNumberPlaceholderHandler</c>.</description></item> |
44 | 45 |
|
45 | | - <item><c>${xmlunit.matchesRegex}</c> makes the comparison pass |
46 | | - if the textual content of the element or attribute matches the |
47 | | - regular expression specified as the first (and only) argument. |
48 | | - If there is no argument at all, the comparison will fail. This |
49 | | - is handled by <see |
50 | | - cref="MatchesRegexPlaceholderHandler"/>.</item> |
| 46 | + <item><term><c>${xmlunit.matchesRegex}</c></term> |
| 47 | + <description> makes the comparison pass if the textual content |
| 48 | + of the element or attribute matches the regular expression |
| 49 | + specified as the first (and only) argument. If there is no |
| 50 | + argument at all, the comparison will fail. This is handled by |
| 51 | + <c>MatchesRegexPlaceholderHandler</c>.</description></item> |
51 | 52 |
|
52 | | - <item><c>${xmlunit.isDateTime}</c> makes the comparison pass |
53 | | - if the textual content of the element or attributes looks like |
54 | | - a date or datetime in the current locale or parsed by ISO |
55 | | - rules. An optional argument can be used to specify a pattern |
56 | | - unserstood by <see cref="DateTime.ParseExact"/> to use when |
57 | | - trying to parse the test. This is handled by <see |
58 | | - cref="IsDateTimePlaceholderHandler"/>.</item> |
| 53 | + <item><term><c>${xmlunit.isDateTime}</c></term> <description> |
| 54 | + makes the comparison pass if the textual content of the |
| 55 | + element or attributes looks like a date or datetime in the |
| 56 | + current locale or parsed by ISO rules. An optional argument |
| 57 | + can be used to specify a pattern unserstood by |
| 58 | + <c>DateTime.ParseExact</c> to use when trying to parse the |
| 59 | + test. This is handled by |
| 60 | + <c>IsDateTimePlaceholderHandler</c>.</description></item> |
59 | 61 |
|
60 | | - </list |
| 62 | + </list> |
61 | 63 |
|
62 | 64 | <para>The default delimiters of <c>${</c> and <c>}</c> can be |
63 | 65 | overwritten using custom regular expressions.</para> |
64 | 66 |
|
65 | 67 | <para>The easiest way to activate the placeholder feature is to |
66 | | - use one of the methods in <see cref="PlaceholderSupport"/> to |
67 | | - add it to a <see cref="org.xmlunit.builder.DiffBuilder"/> or |
| 68 | + use one of the methods in <c>PlaceholderSupport</c> to add it to |
| 69 | + a <c>org.xmlunit.builder.DiffBuilder</c> or |
68 | 70 | <c>org.xmlunit.matchers.CompareMatcher</c> instance. The |
69 | | - alternative approach is to create an instance of <see |
70 | | - cref="PlaceholderDifferenceEvaluator"/> as a <see |
71 | | - cref="org.xmlunit.diff.DifferenceEvaluator"/> and add it to the |
| 71 | + alternative approach is to create an instance of |
| 72 | + <c>PlaceholderDifferenceEvaluator</c> as a |
| 73 | + <c>org.xmlunit.diff.DifferenceEvaluator</c> and add it to the |
72 | 74 | builder yourself.</para> |
73 | 75 |
|
74 | 76 | </remarks> |
|
0 commit comments