Merge & Update

1 files changed, 22 insertions, 0 deletions

diff --git a/base/src/main/java/bjc/utils/ioutils/blocks/package-info.java b/base/src/main/java/bjc/utils/ioutils/blocks/package-info.java
new file mode 100644
index 0000000..3d05ed4
--- /dev/null
+++ b/base/src/main/java/bjc/utils/ioutils/blocks/package-info.java
@@ -0,0 +1,22 @@
+/** This package contains a number of classes useful for processing input that
+ * is structured as a series of 'blocks' or records.
+ * <p>
+ *
+ * The most fundamental unit here is that of {@link Block}. Each {@link
+ * BlockReader} will yield a sequence of these, which contain a piece of text
+ * as its contents, as well as the beginning/ending line for that block.
+ *
+ * There are a number of different types of {@link BlockReader}, which are
+ * summarized here.
+ * </p>
+ *
+ * <dl>
+ * 	<dt>{@link SimpleBlockReader}</dt>
+ * 	<dd>
+ * 		The most basic form of BlockReader. This uses a regular expression to
+ * 		delimit input reader from a {@link Reader} into a series of blocks.
+ * 		Listed first, because this is
+ * 	</dd>
+ * </dl>
+ * @author Ben Culkin */
+package bjc.utils.ioutils.blocks;