doc: Add document

Author: DanSnow

src/binary_parser.cr

@@ -1,11 +1,31 @@
 require "./binary_parser/macros/*"
 
+# BinaryParser for Crystal
+#
+# ```crystal
+# class Parser < BinaryParser
+#   uint8 :value
+# end
+#
+# io = IO::Memory.new(sizeof(UInt8))
+# io.write_bytes(42)
+# io.rewind
+# parser = Parser.new.load(io)
+#
+# parser.value # 42
+# ```
+#
 class BinaryParser
+
+  # Load from file with `filename`
+  #
   def load(filename : String)
     io = File.open(filename)
     load(io)
   end
 
+  # Load from an IO object
+  #
   def load(io : IO)
     {% for method in @type.methods %}
       {% if method.name.starts_with?("_read_") %}
@@ -15,15 +35,25 @@ class BinaryParser
     self
   end
 
+  # Save to file with `filename`
+  #
   def save(filename : String)
     io = File.open(filename, "w")
     write(io)
   end
 
+  # Convert to string
+  #
+  # ```crystal
+  # File.write("filename", parser)
+  # ```
+  #
   def to_s(io : IO)
     write(io)
   end
 
+  # Write to an IO object
+  #
   def write(io : IO)
     {% for method in @type.methods %}
       {% if method.name.starts_with?("_write_") %}
@@ -33,11 +63,17 @@ class BinaryParser
     self
   end
 
+  # Support for `IO#read_bytes`
+  #
+  # **NOTICE**: Current not respect to `IO::ByteFormat`
   def self.from_io(io : IO, format : IO::ByteFormat)
     ins = self.new
     ins.load(io)
   end
 
+  # Support for `IO#write_bytes`
+  #
+  # **NOTICE**: Current not respect to `IO::ByteFormat`
   def to_io(io : IO, format : IO::ByteFormat)
     write(io)
   end

src/binary_parser/macros/int16.cr

@@ -1,4 +1,10 @@
 class BinaryParser
+  #
+  # Declare a int16 field
+  #
+  # ```crystal
+  # int16 :value # name of field
+  # ```
   macro int16(name)
     property! :{{name.id}}
     @{{name.id}} = 0i16

src/binary_parser/macros/int32.cr

@@ -1,4 +1,10 @@
 class BinaryParser
+
+  # Declare a int32 field
+  #
+  # ```crystal
+  # int32 :value # name of field
+  # ```
   macro int32(name)
     property! :{{name.id}}
     @{{name.id}} = 0i32

src/binary_parser/macros/int8.cr

@@ -1,4 +1,10 @@
 class BinaryParser
+
+  # Declare a int8 field
+  #
+  # ```crystal
+  # int8 :value # name of field
+  # ```
   macro int8(name)
     property! :{{name.id}}
     @{{name.id}} = 0i8

src/binary_parser/macros/uint16.cr

@@ -1,4 +1,10 @@
 class BinaryParser
+
+  # Declare a uint16 field
+  #
+  # ```crystal
+  # uint16 :value # name of field
+  # ```
   macro uint16(name)
     property! :{{name.id}}
     @{{name.id}} = 0u16

src/binary_parser/macros/uint32.cr

@@ -1,4 +1,10 @@
 class BinaryParser
+
+  # Declare a uint32 field
+  #
+  # ```crystal
+  # uint32 :value # name of field
+  # ```
   macro uint32(name)
     property! :{{name.id}}
     @{{name.id}} = 0u32

src/binary_parser/macros/uint8.cr

@@ -1,4 +1,10 @@
 class BinaryParser
+
+  # Declare a uint8 field
+  #
+  # ```crystal
+  # uint8 :value # name of field
+  # ```
   macro uint8(name)
     property! :{{name.id}}
     @{{name.id}} = 0u8