#86: doc

yegor256 · Jun 6, 2017 · 0d27ede · 0d27ede
1 parent 249bb28
commit 0d27ede
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/main/java/org/cactoos/io/ResourceAsInput.java b/src/main/java/org/cactoos/io/ResourceAsInput.java
@@ -29,7 +29,12 @@
 import org.cactoos.text.FormattedText;
 
 /**
- * Jar class resource.
+ * Classpath resource.
+ *
+ * <p>Pay attention that the name of resource must always be
+ * global, <strong>not</strong> starting with a leading slash. Thus,
+ * if you want to load a text file from {@code /com/example/Test.txt},
+ * you must provide this name: {@code "com/example/Test.txt"}.</p>
  *
  * @author Kirill (g4s8.public@gmail.com)
  * @version $Id$