packetgen 4.0.0 → 4.1.0

data/lib/packetgen/header/http/headers.rb

@@ -9,14 +9,15 @@
 module PacketGen
   module Header
     # @since 2.2.0
+    # @author Kent 'picat' Gruber
     module HTTP
       # @abstract Base class for HTTP headers.
       # @author Kent 'picat' Gruber
       class Headers
         include BinStruct::Structable
 
-        # Underlying Headers data (or nil).
-        # @return [Hash, nil]
+        # Underlying Headers data.
+        # @return [Hash{String => String}, nil]
         attr_reader :data
         alias to_h data
 
@@ -25,7 +26,7 @@ module PacketGen
         end
 
         # Populate object from a string or directly from a hash.
-        # @param [String, Hash] s_or_h
+        # @param [String, Hash{String=>String}] s_or_h
         # @return [self]
         def read(s_or_h)
           case s_or_h
@@ -69,14 +70,14 @@ module PacketGen
           d.join("\r\n") << "\r\n\r\n"
         end
 
-        # Get a human readable string.
+        # Get a human readable hash.
         # @return [Hash]
         def to_human
           @data
         end
 
         # Read human-readable data to populate header data.
-        # @param [Hash] data
+        # @param [Hash{String=>String}] data
         # @return [self]
         def from_human(data)
           read(data)

data/lib/packetgen/header/http/request.rb

@@ -10,28 +10,30 @@ module PacketGen
   module Header
     module HTTP
       # An HTTP/1.1 Request packet consists of:
-      # * the http verb ({BinStruct::String}).
-      # * the path ({BinStruct::String}).
-      # * the version ({BinStruct::String}).
+      # * the http verb (+BinStruct::String+).
+      # * the path (+BinStruct::String+).
+      # * the version (+BinStruct::String+).
       # * associated http headers ({HTTP::Headers}).
+      # * and a {#body} (+BinStruct::String+).
       #
-      # == Create a HTTP Request header
+      # Note: When creating a HTTP Request packet, {TCP#sport} and {TCP#dport}
+      # attributes are not set.
+      #
+      # @example Create a HTTP Request header
       #   # standalone
-      #   http_rqst = PacketGen::Header::HTTP::Request.new
+      #   http_request = PacketGen::Header::HTTP::Request.new
       #   # in a packet
       #   pkt = PacketGen.gen("IP").add("TCP").add("HTTP::Request")
       #   # access to HTTP Request header
-      #   pkt.http_request # => PacketGen::Header::HTTP::Request
-      #
-      # Note: When creating a HTTP Request packet, +sport+ and +dport+
-      # attributes of TCP header are not set.
+      #   pkt.http_request.class # => PacketGen::Header::HTTP::Request
       #
-      # == HTTP Request attributes
-      #   http_rqst.version = "HTTP/1.1"
-      #   http_rqst.verb  = "GET"
-      #   http_rqst.path    = "/meow.html"
-      #   http_rqst.headers = "Host: tcpdump.org"     # string or
-      #   http_rqst.headers = { "Host": "tcpdump.org" } # even a hash
+      # @example HTTP Request attributes
+      #   http_request = PacketGen::Header::HTTP::Request.new
+      #   http_request.version #=> "HTTP/1.1"
+      #   http_request.verb  = "GET"
+      #   http_request.path    = "/meow.html"
+      #   http_request.headers = "Host: tcpdump.org"     # string or
+      #   http_request.headers = { "Host": "tcpdump.org" } # even a hash
       #
       # @author Kent 'picat' Gruber
       # @author Sylvain Daubert
@@ -39,13 +41,16 @@ module PacketGen
       # @since 3.1.0 Rename +#method+ into {#verb} to not mask +Object#method+.
       class Request < Base
         # @!attribute verb
+        #   HTTP verb (method)
         #   @return [BinStruct::String]
         #   @since 3.1.0
         define_attr :verb, BinStruct::String
         # @!attribute path
+        #   Requested path
         #   @return [BinStruct::String]
         define_attr :path,    BinStruct::String
         # @!attribute version
+        #   HTTP version
         #   @return [BinStruct::String]
         define_attr :version, BinStruct::String, default: 'HTTP/1.1'
         # @!attribute headers
@@ -53,6 +58,7 @@ module PacketGen
         #   @return [HTTP::Headers]
         define_attr :headers, HTTP::Headers
         # @!attribute body
+        #   HTTP request body, if any
         #   @return [BinStruct::String]
         define_attr :body, BinStruct::String
 
@@ -67,7 +73,7 @@ module PacketGen
         end
 
         # Read in the HTTP portion of the packet, and parse it.
-        # @return [PacketGen::HTTP::Request]
+        # @return [self]
         def read(str)
           lines = lines(str)
           first_line_words = lines.shift.split
@@ -83,6 +89,8 @@ module PacketGen
           self
         end
 
+        # May be parsed as a HTTP request if verb is known, and if version is +HTTP/1.x+.
+        # @return [Boolean]
         def parse?
           VERBS.include?(self.verb) && self.version.start_with?('HTTP/1.')
         end

data/lib/packetgen/header/http/response.rb

@@ -10,25 +10,26 @@ module PacketGen
   module Header
     module HTTP
       # An HTTP/1.1 Response packet consists of:
-      # * the version ({BinStruct::String}).
-      # * the status code ({BinStruct::String}).
-      # * the status message ({BinStruct::String}).
-      # * associated http headers ({HTTP::Headers}).
-      # * the actual http payload body ({BinStruct::String}).
+      # * the version (+BinStruct::String+).
+      # * the status code (+BinStruct::String+).
+      # * the status message (+BinStruct::String+).
+      # * associated HTTP headers ({HTTP::Headers}).
+      # * the actual HTTP payload body (+BinStruct::String+).
       #
-      # == Create a HTTP Response header
+      # Note: When creating a HTTP Response packet, +sport+ and +dport+
+      # attributes of TCP header are not set.
+      #
+      # @example Create a HTTP Response header
       #   # standalone
       #   http_resp = PacketGen::Header::HTTP::Response.new
       #   # in a packet
       #   pkt = PacketGen.gen("IP").add("TCP").add("HTTP::Response")
       #   # access to HTTP Response header
-      #   pkt.http_response # => PacketGen::Header::HTTP::Response
+      #   pkt.http_response.class # => PacketGen::Header::HTTP::Response
       #
-      # Note: When creating a HTTP Response packet, +sport+ and +dport+
-      # attributes of TCP header are not set.
-      #
-      # == HTTP Response attributes
-      #   http_resp.version     = "HTTP/1.1"
+      # @example HTTP Response attributes
+      #   http_resp = PacketGen::Header::HTTP::Response.new
+      #   http_resp.version     #=> "HTTP/1.1"
       #   http_resp.status_code = "200"
       #   http_resp.status_mesg = "OK"
       #   http_resp.body        = "this is a body"
@@ -39,20 +40,24 @@ module PacketGen
       # @author LemonTree55
       class Response < Base
         # @!attribute version
+        #   HTTP version
         #   @return [BinStruct::String]
         define_attr :version,     BinStruct::String, default: 'HTTP/1.1'
         # @!attribute status_code
+        #   Response status code
         #   @return [BinStruct::String]
         define_attr :status_code, BinStruct::String
         # @!attribute status_mesg
+        #   Response status message
         #   @return [BinStruct::String]
         define_attr :status_mesg, BinStruct::String
         # @!attribute headers
         #   associated http/1.1 headers
-        #   @return [BinStruct::String]
+        #   @return [HTTP::Headers]
         define_attr :headers, HTTP::Headers
         # @!attribute body
-        #   @return [HTTP::PHeaders]
+        #   Response body
+        #   @return [BinStruct::String]
         define_attr :body, BinStruct::String
 
         # @param [Hash] options
@@ -67,7 +72,7 @@ module PacketGen
         end
 
         # Read in the HTTP portion of the packet, and parse it.
-        # @return [PacketGen::HTTP::Response]
+        # @return [self]
         def read(str)
           headers, data = collect_headers_and_data(str)
 
@@ -80,6 +85,8 @@ module PacketGen
           self
         end
 
+        # May be parsed as a HTTP response if version is +HTTP/1.x+.
+        # @return [Boolean]
         def parse?
           version.start_with?('HTTP/1.')
         end

data/lib/packetgen/header/icmp.rb

@@ -15,24 +15,25 @@ module PacketGen
     #   |     Type      |     Code      |          Checksum             |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A ICMP header consists of:
-    # * a {#type} field ({BinStruct::Int8} type),
-    # * a {#code} field ({BinStruct::Int8} type),
-    # * a {#checksum} field ({BinStruct::Int16} type),
+    # * a {#type} field (+BinStruct::Int8+ type),
+    # * a {#code} field (+BinStruct::Int8+ type),
+    # * a {#checksum} field (+BinStruct::Int16+ type),
     # * and a {#body}.
     #
-    # == Create a ICMP header
+    # @example Create a ICMP header
     #  # standalone
     #  icmp = PacketGen::Header::ICMP.new
     #  # in a packet
     #  pkt = PacketGen.gen('IP').add('ICMP')
     #  # access to ICMP header
-    #  pkt.icmp     # => PacketGen::Header::ICMP
+    #  pkt.icmp.class   # => PacketGen::Header::ICMP
     #
-    # == ICMP attributes
+    # @example ICMP attributes
+    #  icmp = PacketGen::Header::ICMP.new
     #  icmp.code = 0
     #  icmp.type = 200
     #  icmp.checksum = 0x248a
-    #  icmp.body.read 'this is a body'
+    #  icmp.body = 'this is a body'
     # @author Sylvain Daubert
     class ICMP < Base
       # ICMP internet protocol number
@@ -51,7 +52,8 @@ module PacketGen
       #  @return [Integer]
       define_attr :checksum, BinStruct::Int16
       # @!attribute body
-      #  @return [BinStruct::String,Header::Base]
+      # ICMP body
+      #  @return [BinStruct::String,Headerable]
       define_attr :body, BinStruct::String
 
       # Compute checksum and set +checksum+ field
@@ -61,9 +63,7 @@ module PacketGen
         self.checksum = IP.reduce_checksum(sum)
       end
     end
-
     self.add_class ICMP
-
     IP.bind ICMP, protocol: ICMP::IP_PROTOCOL
   end
 end

data/lib/packetgen/header/icmpv6.rb

@@ -15,30 +15,31 @@ module PacketGen
     #   |     Type      |     Code      |          Checksum             |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A ICMPv6 header consists of:
-    # * a +type+ field ({BinStruct::Int8} type),
-    # * a +code+ field ({BinStruct::Int8} type),
-    # * a +checksum+ field ({BinStruct::Int16} type),
-    # * and a +body+.
+    # * a {#type #type} field (+BinStruct::Int8+ type),
+    # * a {#code #code} field (+BinStruct::Int8+ type),
+    # * a {#checksum #checksum} field (+BinStruct::Int16+ type),
+    # * and a {#body #body}.
     #
-    # == Create a ICMPv6 header
+    # @example Create a ICMPv6 header
     #  # standalone
     #  icmpv6 = PacketGen::Header::ICMPv6.new
     #  # in a packet
     #  pkt = PacketGen.gen('IPv6').add('ICMPv6')
     #  # access to ICMPv6 header
-    #  pkt.icmpv6     # => PacketGen::Header::ICMPv6
+    #  pkt.icmpv6.class  # => PacketGen::Header::ICMPv6
     #
-    # == ICMPv6 attributes
+    # @example ICMPv6 attributes
+    #  icmpv6 = PacketGen::Header::ICMPv6.new
     #  icmpv6.code = 0
     #  icmpv6.type = 200
     #  icmpv6.checksum = 0x248a
-    #  icmpv6.body.read 'this is a body'
+    #  icmpv6.body = 'this is a body'
     # @author Sylvain Daubert
     class ICMPv6 < ICMP
       # ICMPv6 internet protocol number
       IP_PROTOCOL = 58
 
-      # Compute checksum and set +checksum+ field
+      # Compute IPV6-style checksum and set +checksum+ field
       # @return [Integer]
       def calc_checksum
         sum = ip_header(self).pseudo_header_checksum

data/lib/packetgen/header/igmp.rb

@@ -20,25 +20,29 @@ module PacketGen
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # A IGMP header consists of:
-    # * a {#type} field ({BinStruct::Int8Enum} type),
-    # * a {#max_resp_time} field ({BinStruct::Int8} type),
-    # * a {#checksum} field ({BinStruct::Int16} type),
+    # * a {#type} field (+BinStruct::Int8Enum+ type),
+    # * a {#max_resp_time} field (+BinStruct::Int8+ type),
+    # * a {#checksum} field (+BinStruct::Int16+ type),
     # * a {#group_addr} field ({Header::IP::Addr} type),
     # * and a {#body} (unused for IGMPv2).
     #
-    # == Create a IGMP header
+    # After adding a IGMP header to a packet, you have to call {#igmpize} to ensure
+    # resulting packet conforms to RFC 2236.
+    #
+    # @example Create a IGMP header
     #  # standalone
     #  igmp = PacketGen::Header::IGMP.new
     #  # in a packet
     #  pkt = PacketGen.gen('IP').add('IGMP')
     #  # access to IGMP header
-    #  pkt.igmp    # => PacketGen::Header::IGMP
+    #  pkt.igmp.class  # => PacketGen::Header::IGMP
     #
-    # == IGMP attributes
-    #  icmp.type = 'MembershipQuery'   # or 0x11
-    #  icmp.max_resp_time = 20
-    #  icmp.checksum = 0x248a
-    #  icmp.group_addr = '224.0.0.1'
+    # @example IGMP attributes
+    #  igmp = PacketGen::Header::IGMP.new
+    #  igmp.type = 'MembershipQuery'   # or 0x11
+    #  igmp.max_resp_time = 20
+    #  igmp.checksum = 0x248a
+    #  igmp.group_addr = '224.0.0.1'
     # @author Sylvain Daubert
     # @since 2.4.0
     class IGMP < Base
@@ -70,12 +74,14 @@ module PacketGen
       #  @return [IP::Addr]
       define_attr :group_addr, IP::Addr, default: '0.0.0.0'
       # @!attribute body
+      #  IGMP body (not used in IGMPv2)
       #  @return [String,Base]
       define_attr :body, BinStruct::String
 
       # @api private
       # @note This method is used internally by PacketGen and should not be
       #       directly called
+      #   Define +#igmpize+ method onto +packet+. This method calls {#igmpize}.
       def added_to_packet(packet)
         igmp_idx = packet.headers.size
         packet.instance_eval "def igmpize() @headers[#{igmp_idx}].igmpize; end" # def igmpize() @headers[2].igmpize; end
@@ -103,6 +109,11 @@ module PacketGen
       #    pkt.igmp.igmpize
       #    # second method
       #    pkt.igmpize
+      # @example
+      #   pkt = PacketGen.gen('IP').add('IGMP', type: 'MembershipQuery', max_resp_time: 20, group_addr: '1.2.3.4')
+      #   pkt.igmpize
+      #   pkt.ip.ttl     #=> 1
+      #   pkt.ip.options.map(&:class) #=> [PacketGen::Header::IP::RA]
       # @return [void]
       def igmpize
         iph = ip_header(self)

data/lib/packetgen/header/igmpv3/group_record.rb

@@ -11,7 +11,7 @@ module PacketGen
     class IGMPv3
       # Class to handle IGMPv3 Group Records.
       #
-      # A Group Record is a block of attributes.containing information
+      # A Group Record is a block of attributes containing information
       # pertaining to the sender's membership in a single multicast group on
       # the interface from which the Report is sent.
       #
@@ -76,14 +76,19 @@ module PacketGen
         define_attr :source_addr, IP::ArrayOfAddr,
                     builder: ->(h, t) { t.new(counter: h[:number_of_sources]) }
         # @!attribute aux_data
+        #    Not used in IGMPv3
         #  @return [String]
         define_attr :aux_data, BinStruct::String,
                     builder: ->(h, t) { t.new(length_from: -> { h[:aux_data_len].to_i * 4 }) }
 
+        # Human-readable type
+        # @return [String]
         def human_type
           self[:type].to_human
         end
 
+        # Human-readable description of a group record
+        # @return [String]
         def to_human
           "#{human_type}(ma:#{multicast_addr}|src:#{source_addr.to_human})"
         end
@@ -94,7 +99,7 @@ module PacketGen
       class GroupRecords < BinStruct::Array
         set_of GroupRecord
 
-        # Separator used in {#to_human}.
+        # Separator used in +#to_human+.
         HUMAN_SEPARATOR = ';'
       end
     end

data/lib/packetgen/header/igmpv3/mq.rb

@@ -49,7 +49,7 @@ module PacketGen
         #  First 8-bit field, composed of {#resv}, {#flag_s} and {#qrv}
         #  @return [Integer]
         # @!attribute resv
-        #  4-bit reserved field in
+        #  4-bit reserved field
         #  @return [Integer]
         # @!attribute flag_s
         #  1-bit S flag (Suppress Router-Side Processing)

data/lib/packetgen/header/igmpv3/mr.rb

@@ -48,7 +48,7 @@ module PacketGen
       class MR < Base
         # @!attribute reserved
         #  16-bit reserved field
-        # @return [Integer]
+        #  @return [Integer]
         define_attr :reserved, BinStruct::Int16, default: 0
         # @!attribute number_of_gr
         #  16-bit Number of group records in {#group_records}

data/lib/packetgen/header/igmpv3.rb

@@ -18,23 +18,24 @@ module PacketGen
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # A IGMP header consists of:
-    # * a {#type} field ({BinStruct::Int8Enum} type),
-    # * a {#max_resp_time} field ({BinStruct::Int8} type),
-    # * a {#checksum} field ({BinStruct::Int16} type),
-    # * and a {#body}, containing more fields (see below).
+    # * a {#type #type} field (+BinStruct::Int8Enum+ type),
+    # * a {#max_resp_time #max_resp_time} field (+BinStruct::Int8+ type),
+    # * a {#checksum #checksum} field (+BinStruct::Int16+ type),
+    # * and a {#body #body}, containing more fields (see below).
     #
-    # A IGMPv3 header may have additionnal fields. These attributes.are handled by
+    # A IGMPv3 header may have additionnal fields. These attributes are handled by
     # additional headers (see {IGMPv3::MQ}).
     #
-    # == Create a IGMPv3 header
+    # @example Create a IGMPv3 header
     #  # standalone
     #  igmp = PacketGen::Header::IGMPv3.new
     #  # in a packet
     #  pkt = PacketGen.gen('IP').add('IGMPv3')
     #  # access to IGMPv3 header
-    #  pkt.igmp    # => PacketGen::Header::IGMPv3
+    #  pkt.igmpv3.class  # => PacketGen::Header::IGMPv3
     #
-    # == IGMPv3 attributes
+    # @example IGMPv3 attributes
+    #  igmp = PacketGen::Header::IGMPv3.new
     #  igmp.type = 'MembershipQuery'   # or 0x11
     #  igmp.max_resp_time = 20
     #  igmp.checksum = 0x248a
@@ -50,14 +51,14 @@ module PacketGen
     #   igmp.max_resp_code   #=> 9728  error due to encoding as a floating point value
     #
     # === IGMPv3 Membership Query
-    # With IGMPv3, a Membership Query packet has more attributes.than with IGMPv2. To
+    # With IGMPv3, a Membership Query packet has more attributes than with IGMPv2. To
     # handle those fields, an additional header should be used:
     #   pkt = PacketGen.gen('IP').add('IGMPv3', type: 'MembershipQuery').add('IGMPv3::MQ')
     #   pkt.igmpv3      #=> PacketGen::Header::IGMPv3
     #   pkt.igmpv3_mq   #=> PacketGen::Header::IGMPv3::MQ
     #
     # === IGMPv3 Membership Report
-    # With IGMPv3, a Membership Report packet has more attributes.than with IGMPv2. To
+    # With IGMPv3, a Membership Report packet has more attributes than with IGMPv2. To
     # handle those fields, an additional header should be used:
     #   pkt =  PacketGen.gen('IP').add('IGMPv3', type: 'MembershipQuery').add('IGMPv3::MR')
     #   pkt.igmpv3      #=> PacketGen::Header::IGMPv3

data/lib/packetgen/header/ip/addr.rb

@@ -18,7 +18,7 @@ module PacketGen
         #  @return [Integer] IP address first byte
         define_attr :a1, BinStruct::Int8
         # @!attribute a2
-        #  @return [Integer] IP address seconf byte
+        #  @return [Integer] IP address second byte
         define_attr :a2, BinStruct::Int8
         # @!attribute a3
         #  @return [Integer] IP address third byte
@@ -27,6 +27,7 @@ module PacketGen
         #  @return [Integer] IP address fourth byte
         define_attr :a4, BinStruct::Int8
 
+        ## Regex to match IPv4 addresses
         IPV4_ADDR_REGEX = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/
 
         # Read a dotted address
@@ -51,7 +52,7 @@ module PacketGen
           attributes.map { |f| self[f].to_i.to_s }.join('.')
         end
 
-        # Addr as an integer
+        # Addr as a 32-bit integer
         # @return [Integer]
         def to_i
           (self.a1 << 24) | (self.a2 << 16) | (self.a3 << 8) |
@@ -64,6 +65,9 @@ module PacketGen
           self.a1 >= 224 && self.a1 <= 239
         end
 
+        # Check equality.
+        # Equal is other has same class and all attributes are equal.
+        # @return [Boolean]
         def ==(other)
           other.is_a?(self.class) &&
             attributes.all? { |attr| self[attr].value == other[attr].value }

data/lib/packetgen/header/ip/option.rb

@@ -17,7 +17,11 @@ module PacketGen
         # Push a IP address to the array
         # @param [String,Addr] addr
         # @return [self]
+        # @example
+        #   array = PacketGen::Header::IP::ArrayOfAddr.new
+        #   # #<< uses #push internally
         #   array << '192.168.1.12'
+        #   array.push(PacketGen::Header::IP::Addr.new.from_human('192.18.1.13'))
         def push(addr)
           addr = Addr.new.from_human(addr) unless addr.is_a?(Addr)
           super
@@ -46,7 +50,7 @@ module PacketGen
 
         # @!attribute type
         #  8-bit option type
-        # @return [Integer]
+        #  @return [Integer]
         # @!attribute copied
         #  1-bit copied flag from {#type} field
         #  @return [Integer]
@@ -60,15 +64,17 @@ module PacketGen
         define_bit_attr :type, copied: 1, option_class: 2, number: 5
         # @!attribute length
         #  8-bit option length. If 0, there is no +length+ field in option
-        # @return [Integer]
+        #  @return [Integer]
         define_attr :length, BinStruct::Int8, default: 0, optional: ->(h) { h.type > 1 }
         # @!attribute data
         #  option data
-        # @return [String]
+        #  @return [String]
         define_attr :data, BinStruct::String, optional: ->(h) { h.length > 2 },
                                               builder: ->(h, t) { t.new(length_from: -> { h.length - 2 }) }
 
-        # @return [Hash]
+        # @private
+        # Return a cached hash associating type name to its value.
+        # @return [Hash{String => Integer}]
         def self.types
           return @types if defined? @types
 
@@ -83,6 +89,7 @@ module PacketGen
         end
 
         # Factory to build an option from its type
+        # @param [Hash] options
         # @return [Option]
         def self.build(options={})
           type = options[:type]
@@ -96,6 +103,8 @@ module PacketGen
           klass.new(options)
         end
 
+        # Force type value for subclasses, if not specified
+        # @return [Option]
         def initialize(options={})
           options[:type] = class2type unless options[:type]
 
@@ -153,7 +162,7 @@ module PacketGen
         remove_attr :data
 
         # @!attribute pointer
-        #  8-bit pointer on next address
+        #  8-bit po+++inter on next address
         #  @return [Integer]
         define_attr :pointer, BinStruct::Int8, default: 4
         # @!attribute data
@@ -190,6 +199,8 @@ module PacketGen
         #  @return [Integer]
         define_attr :id, BinStruct::Int16
 
+        # Return a human-readable string
+        # @return [String]
         def to_human
           super << ":#{self.id}"
         end
@@ -204,6 +215,8 @@ module PacketGen
         #  @return [Integer]
         define_attr :value, BinStruct::Int16, default: 0
 
+        # Return a human-readable string
+        # @return [String]
         def to_human
           super << ":#{self.value}"
         end