A number of minor documentation fixes

Author: hlship

src/io/aviso/ansi.clj

@@ -2,14 +2,19 @@
   "Help with generating textual output that includes ANSI escape codes for formatting."
   (:require [clojure.string :as str]))
 
-;; control sequence initiator: ESC [
-(def ^:const csi "\u001b[")
+(def ^:const csi
+  "The control sequence initiator: ESC ["
+  "\u001b[")
 
 ;; select graphic rendition
-(def ^:const sgr "m")
+(def ^:const sgr
+  "The Select Graphic Rendition suffix: m"
+  "m")
 
-(def ^:const ^{:doc "Resets the font, clearing bold, italic, color, and background color."}
-  reset-font (str csi sgr))
+(def ^:const
+  reset-font
+  "Resets the font, clearing bold, italic, color, and background color."
+  (str csi sgr))
 
 (defn ^:private def-sgr-const
   "Utility for defining a font-modifying constant."

src/io/aviso/binary.clj

@@ -7,7 +7,9 @@
 
 (defprotocol BinaryData
   "Allows various data sources to be treated as a byte-array data type that
-  supports a length and random access to individual bytes."
+  supports a length and random access to individual bytes.
+
+  BinaryData is extended onto byte arrays, onto String, and onto nil."
 
   (data-length [this] "The total number of bytes available.")
   (byte-at [this index] "The byte value at a specific offset."))
@@ -127,8 +129,8 @@
   When one side is shorter than the other, it is padded with -- placeholders to make this
   more clearly visible.
 
-  expected - ByteData
-  actual - ByteData
+  expected - BinaryData
+  actual - BinaryData
 
   Display 16 bytes (from each data set) per line."
   [expected actual]

src/io/aviso/writer.clj

@@ -2,7 +2,10 @@
   "The Writer protocol is used as the target of any written output.")
 
 (defprotocol Writer
-  "May receive strings, which are printed, or stored."
+  "May receive strings, which are printed, or stored.
+
+  Writer is extended onto java.lang.Appendable, a common interface implemented by both PrintWriter and StringBuilder (among
+  many others)"
 
   (write-string [this string] "Writes the string to the Writer."))
 
@@ -26,7 +29,7 @@
 
 (defn writeln
   "Constructs a string from the values (with no seperator) and writes the string to the Writer,
-  followed by a end-of-line terminator."
+  followed by an end-of-line terminator."
   ([writer]
    (write-string writer endline))
   ([writer & values]
@@ -39,7 +42,9 @@
   (write-string writer (apply format fmt values)))
 
 (defn into-string
-  "Creates a StringBuilder and passes that as the first parameter to the function, along with the other parameters."
+  "Creates a StringBuilder and passes that as the first parameter to the function, along with the other parameters.
+
+  Returns the value of the StringBuilder after invoking the function."
   [f & params]
   (let [sb (StringBuilder. 2000)]
     (apply f sb params)