From 683d592c55dbb686c999a9556d3a9f0bbf39f061 Mon Sep 17 00:00:00 2001
From: Collin Smith <collinsmith70@gmail.com>
Date: Sat, 8 Aug 2020 14:26:25 -0700
Subject: [PATCH] Created placeholder documentation to document relationship
 between input classes

---
 core/src/com/riiablo/io/nio/BitInput.java  | 10 ++++++++++
 core/src/com/riiablo/io/nio/ByteInput.java | 10 ++++++++++
 2 files changed, 20 insertions(+)

diff --git a/core/src/com/riiablo/io/nio/BitInput.java b/core/src/com/riiablo/io/nio/BitInput.java
index b3540b4b..f6056c24 100644
--- a/core/src/com/riiablo/io/nio/BitInput.java
+++ b/core/src/com/riiablo/io/nio/BitInput.java
@@ -2,6 +2,16 @@ package com.riiablo.io.nio;
 
 import org.apache.commons.lang3.StringUtils;
 
+/**
+ * Wraps a {@link ByteInput} to support reading sequences of bits and
+ * supporting {@link #align() re-aligning} the byte stream to read sequences of
+ * {@link ByteInput bytes}. All read functions will return results in little
+ * endian byte order.
+ *
+ * @see BitInput
+ * @see #align()
+ */
+// TODO: improve placeholder documentation
 public class BitInput {
   public static BitInput wrap(byte[] bytes) {
     return ByteInput.wrap(bytes).unalign();
diff --git a/core/src/com/riiablo/io/nio/ByteInput.java b/core/src/com/riiablo/io/nio/ByteInput.java
index fde94d70..a2df0b3a 100644
--- a/core/src/com/riiablo/io/nio/ByteInput.java
+++ b/core/src/com/riiablo/io/nio/ByteInput.java
@@ -7,6 +7,16 @@ import java.nio.charset.Charset;
 
 import com.riiablo.util.DebugUtils;
 
+/**
+ * Wraps a {@link ByteBuf} to support reading sequences of bytes and supporting
+ * {@link #unalign() unaligning} the byte stream to read sequences of
+ * {@link BitInput bits}. All read functions will return results in little
+ * endian byte order.
+ *
+ * @see BitInput
+ * @see #unalign()
+ */
+// TODO: improve placeholder documentation
 public class ByteInput {
   private static final ByteInput EMPTY_BYTEINPUT = new ByteInput(Unpooled.EMPTY_BUFFER);
   public static ByteInput emptyByteInput() {