Notes on use

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1752222 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/ooxml/java/org/apache/poi/extractor/ExtractorFactory.java b/src/ooxml/java/org/apache/poi/extractor/ExtractorFactory.java
index 5d9b74f0dced8420fb8fcd055669f10d2b39c0e8..4ba8d8f2f854e80a0ad896384cbd7e377f3217f7 100644 (file)
--- a/src/ooxml/java/org/apache/poi/extractor/ExtractorFactory.java
+++ b/src/ooxml/java/org/apache/poi/extractor/ExtractorFactory.java
@@ -66,6 +66,11 @@ import org.apache.xmlbeans.XmlException;
 /**
  * Figures out the correct POITextExtractor for your supplied
  *  document, and returns it.
+ *  
+ * <p>Note 1 - will fail for many file formats if the POI Scratchpad jar is
+ *  not present on the runtime classpath</p>
+ * <p>Note 2 - rather than using this, for most cases you would be better
+ *  off switching to <a href="http://tika.apache.org">Apache Tika</a> instead!</p>
  */
 @SuppressWarnings("WeakerAccess")
 public class ExtractorFactory {