Skip to content

Commit

Permalink
feat(#213): Expand XML javadoc description
Browse files Browse the repository at this point in the history
  • Loading branch information
volodya-lombrozo committed Jul 19, 2023
1 parent ae7379e commit 81b7b76
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/main/java/com/jcabi/xml/XML.java
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,19 @@
*
* <p>Implementation of this interface must be immutable and thread-safe.
*
* <p> In most cases, you can use the {@link XMLDocument} implementation. It
* implements all required features and will be sufficient for most practical tasks.
* The only problem with that implementation is that it uses javax.xml classes under
* the hood. The issue with the default java implementation is that it only supports
* XPath 1.0. If you require XPath 2.0 support and beyond, you can use the Saxon
* implementation of {@link XML} - {@link SaxonDocument}. It is based on the Saxon
* library and supports XPath 2.0 and higher.
* You can read more about Java XPath versioning problems in the following threads:
* <ul>
* <li><a href="https://stackoverflow.com/questions/6624149/xpath-2-0-for-java-possible">xpath 2.0 for java possible</a></li>
* <li><a href="https://stackoverflow.com/questions/5802895/does-jdk-6-support-all-features-of-xpath-2-0/5803028#5803028">does JDK 6 support all features of XPath 2.0?</a></li>
* </ul>
*
* @see XMLDocument
* @since 0.1
* @checkstyle AbbreviationAsWordInNameCheck (5 lines)
Expand Down

1 comment on commit 81b7b76

@0pdd
Copy link

@0pdd 0pdd commented on 81b7b76 Jul 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Puzzle 221-807476ba disappeared from src/test/java/com/jcabi/xml/XMLDocumentTest.java), that's why I closed #213. Please, remember that the puzzle was not necessarily removed in this particular commit. Maybe it happened earlier, but we discovered this fact only now.

Please sign in to comment.