packetgen 4.0.0 → 4.1.0

data/lib/packetgen/header/ip.rb

@@ -27,32 +27,33 @@ module PacketGen
     #   |                    Options                    |    Padding    |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A IP header consists of:
-    # * a first byte ({#u8} of {BinStruct::Int8} type) composed of:
+    # * a first byte ({#u8} of +BinStruct::Int8+ type) composed of:
     #   * a 4-bit {#version} field,
     #   * a 4-bit IP header length ({#ihl}) field,
-    # * a Type of Service field ({#tos}, {BinStruct::Int8} type),
-    # * a total length ({#length}, {BinStruct::Int16} type),
-    # * a ID ({#id}, +Int16+ type),
-    # * a {#frag} worg (+Int16+) composed of:
+    # * a Type of Service field ({#tos}, +BinStruct::Int8+ type),
+    # * a total length ({#length}, +BinStruct::Int16+ type),
+    # * a ID ({#id}, +BinStruct::Int16+ type),
+    # * a {#frag} worg (+BinStruct::Int16+) composed of:
     #   * 3 1-bit flags ({#flag_rsv}, {#flag_df} and {#flag_mf}),
     #   * a 13-bit {#fragment_offset} field,
     # * a Time-to-Live ({#ttl}) field (+Int8+),
-    # * a {#protocol} field (+Int8+),
-    # * a {#checksum} field (+Int16+),
+    # * a {#protocol} field (+BinStruct::Int8+),
+    # * a {#checksum} field (+BinStruct::Int16+),
     # * a source IP address ({#src}, {Addr} type),
-    # * a destination IP address ({#dst}, +Addr+ type),
+    # * a destination IP address ({#dst}, {Addr} type),
     # * an optional {#options} field ({Options} type),
-    # * and a {#body} ({BinStruct::String} type).
+    # * and a {#body} (+BinStruct::String+ type).
     #
-    # == Create a IP header
+    # @example Create a IP header
     #  # standalone
     #  ip = PacketGen::Header::IP.new
     #  # in a packet
     #  pkt = PacketGen.gen('IP')
     #  # access to IP header
-    #  pkt.ip   # => PacketGen::Header::IP
+    #  pkt.ip.class   # => PacketGen::Header::IP
     #
-    # == IP attributes
+    # @example IP attributes
+    #  ip = PacketGen::Header::IP.new
     #  ip.u8 = 0x45
     #  # the same as
     #  ip.version = 4
@@ -66,21 +67,20 @@ module PacketGen
     #  ip.flag_mf = true
     #  ip.fragment_offset = 0x31
     #
-    #  ip.flag_rsv?  # => Boolean
-    #  ip.flag_df?   # => Boolean
-    #  ip.flag_mf?   # => Boolean
+    #  ip.flag_rsv?  # => false
+    #  ip.flag_df?   # => false
+    #  ip.flag_mf?   # => true
     #
     #  ip.ttl = 0x40
     #  ip.protocol = 6
     #  ip.checksum = 0xffff
     #  ip.src = '127.0.0.1'
     #  ip.src                # => "127.0.0.1"
-    #  ip[:src]              # => PacketGen::Header::IP::Addr
+    #  ip[:src].class        # => PacketGen::Header::IP::Addr
     #  ip.dst = '127.0.0.2'
-    #  ip.body.read 'this is a body'
+    #  ip.body = 'this is a body'
     #
-    # == Add IP options
-    # IP has an {#options} attribute used to store datagram options.
+    # @example Add IP options
     #  pkt = PacketGen.gen('IP')
     #  # add option from class
     #  pkt.ip.options << PacketGen::Header::IP::RA.new
@@ -101,52 +101,68 @@ module PacketGen
       #  First byte of IP header. May be accessed through {#version} and {#ihl}.
       #  @return [Integer] first byte of IP header.
       # @!attribute version
-      #   @return [Integer] 4-bit version attribute
+      #   4-bit version attribute
+      #   @return [Integer]
       # @!attribute ihl
-      #   @return [Integer] 4-bit IP header length attribute
+      #   4-bit IP header length attribute, as 32-bit word count.
+      #   Default to 5 (IP header without option).
+      #   @return [Integer]
       define_bit_attr :u8, default: 0x45, version: 4, ihl: 4
       # @!attribute tos
       #   @return [Integer] 8-bit Type of Service self[attr]
       define_attr :tos, BinStruct::Int8, default: 0
       # @!attribute length
-      #   @return [Integer] 16-bit IP total length
+      #   16-bit IP total length, including this header.
+      #   @return [Integer]
       define_attr :length, BinStruct::Int16, default: 20
       # @!attribute id
       #   @return [Integer] 16-bit ID
       define_attr :id, BinStruct::Int16, default: ->(_) { rand(65_535) }
       # @!attribute frag
-      #   @return [Integer] 16-bit frag word
+      #   16-bit frag word
+      #   @return [Integer]
       # @!attribute flag_rsv
-      #   @return [Boolean] reserved bit from flags
+      #   reserved bit from flags
+      #   @return [Boolean]
       # @!attribute flag_df
-      #   @return [Boolean] Don't Fragment flag
+      #   Don't Fragment flag
+      #   @return [Boolean]
       # @!attribute flag_mf
-      #   @return [Boolean] More Fragment flags
+      #   More Fragment flags
+      #   @return [Boolean]
       # @!attribute fragment_offset
-      #   @return [Integer] 13-bit fragment offset
+      #   13-bit fragment offset
+      #   @return [Integer]
       define_bit_attr :frag, flag_rsv: 1, flag_df: 1, flag_mf: 1, fragment_offset: 13
       # @!attribute ttl
-      #   @return [Integer] 8-bit Time To Live self[attr]
+      #   8-bit Time To Live
+      #   @return [Integer]
       define_attr :ttl, BinStruct::Int8, default: 64
       # @!attribute protocol
-      #   @return [Integer] 8-bit upper protocol self[attr]
+      #   8-bit upper protocol
+      #   @return [Integer]
       define_attr :protocol, BinStruct::Int8
       # @!attribute checksum
-      #   @return [Integer] 16-bit IP header checksum
+      #   16-bit IP header checksum
+      #   @return [Integer]
       define_attr :checksum, BinStruct::Int16, default: 0
       # @!attribute src
-      #   @return [Addr] source IP address
+      #   source IP address
+      #   @return [Addr]
       define_attr :src, Addr, default: '127.0.0.1'
       # @!attribute dst
-      #   @return [Addr] destination IP address
+      #   destination IP address
+      #   @return [Addr]
       define_attr :dst, Addr, default: '127.0.0.1'
       # @!attribute options
+      #  IP options
       #  @since 2.2.0
-      #  @return [BinStruct::String]
+      #  @return [Options]
       define_attr :options, Options, optional: ->(h) { h.ihl > 5 },
                                      builder: ->(h, t) { t.new(length_from: -> { (h.ihl - 5) * 4 }) }
       # @!attribute body
-      #  @return [BinStruct::String,Header::Base]
+      #  IP body
+      #  @return [BinStruct::String,Headerable]
       define_attr :body, BinStruct::String
 
       # Helper method to compute sum of 16-bit words. Used to compute IP-style
@@ -224,7 +240,8 @@ module PacketGen
       end
 
       # Check version field
-      # @see [Base#parse?]
+      # @see Base#parse?
+      # @return [Boolean]
       def parse?
         (version == 4) && (ihl >= 5)
       end

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

@@ -14,6 +14,7 @@ module PacketGen
     class IPv6
       # IPv6 address, as a group of 8 2-byte words
       # @author Sylvain Daubert
+      # @author LemonTree55
       class Addr < BinStruct::Struct
         include BinStruct::Structable
 
@@ -50,11 +51,10 @@ module PacketGen
         #  @return [Integer]
         define_attr :a8, BinStruct::Int16
 
-        # rubocop:disable Metrics/AbcSize
-
         # Read a colon-delimited address
         # @param [String] str
         # @return [self]
+        # @raise [ArgumentError] not a colon-delimited IPv6 address
         def from_human(str)
           return self if str.nil?
 
@@ -62,19 +62,13 @@ module PacketGen
           raise ArgumentError, 'string is not a IPv6 address' unless addr.ipv6?
 
           addri = addr.to_i
-          self.a1 = addri >> 112
-          self.a2 = addri >> 96 & 0xffff
-          self.a3 = addri >> 80 & 0xffff
-          self.a4 = addri >> 64 & 0xffff
-          self.a5 = addri >> 48 & 0xffff
-          self.a6 = addri >> 32 & 0xffff
-          self.a7 = addri >> 16 & 0xffff
-          self.a8 = addri & 0xffff
+          8.times do |i|
+            self.send(:"a#{i + 1}=", addri >> (16 * (7 - i)) & 0xffff)
+          end
           self
         end
-        # rubocop:enable Metrics/AbcSize
 
-        # Addr6 in human readable form (colon-delimited hex string)
+        # Return IPv6 address in human readable form (colon-delimited hex string)
         # @return [String]
         def to_human
           IPAddr.new(to_a.map { |a| a.to_i.to_s(16) }.join(':')).to_s
@@ -92,6 +86,9 @@ module PacketGen
           self.a1 & 0xff00 == 0xff00
         end
 
+        # Check equaliy to +other+.
+        # Equal if other has the 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 }
@@ -106,7 +103,11 @@ module PacketGen
         # Push a IPv6 address to the array
         # @param [String,Addr] addr
         # @return [self]
-        #   array << '2001:1234::125'
+        # @example
+        #   array = PacketGen::Header::IPv6::ArrayOfAddr.new
+        #   # #<< uses #push internally
+        #   array << '2001::1'
+        #   array.push(PacketGen::Header::IPv6::Addr.new.from_human('1:2:3:abcd::1'))
         def push(addr)
           addr = Addr.new.from_human(addr) unless addr.is_a?(Addr)
           super

data/lib/packetgen/header/ipv6/extension.rb

@@ -9,7 +9,7 @@
 module PacketGen
   module Header
     class IPv6
-      # Base class to handle IPv6 extensions
+      # Base class to handle IPv6 extensions.
       # @abstract You should not use this class but its subclasses.
       # A IPv6 extension header has the following format:
       #   0                   1                   2                   3
@@ -25,11 +25,12 @@ module PacketGen
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       #
       # Such a header consists of:
-      # * a {#next} header field ({BinStruct::Int8}),
-      # * a {#length} field ({BinStruct::Int8}),
-      # * an {#options} field ({BinStruct::String}),
+      # * a {#next} header field (+BinStruct::Int8+),
+      # * a {#length} field (+BinStruct::Int8+),
+      # * an {#options} field (+BinStruct::String+),
       # * and a {#body}, containing next header.
       # @author Sylvain Daubert
+      # @since 2.4.0
       class Extension < Base
         # @!attribute next
         #  8-bit Next header field
@@ -44,9 +45,10 @@ module PacketGen
         #  Specific options of extension header
         #  @return [String]
         define_attr :options, BinStruct::String,
-                    builder: ->(h, t) { t.new(length_from: -> { h.real_length }) }
+                    builder: ->(h, t) { t.new(length_from: -> { h.real_length - 2}) }
         # @!attribute body
-        #  @return [String,Base]
+        #  Next header in IPv6 packet
+        #  @return [String,Headerable]
         define_attr :body, BinStruct::String
 
         # Get real extension header length
@@ -55,7 +57,7 @@ module PacketGen
           (length + 1) * 8
         end
 
-        # Compute length and set +len+ field
+        # Compute length and set {#length}+ attribute
         # @return [Integer]
         def calc_length
           self.length = (options.sz + 2) / 8 - 1

data/lib/packetgen/header/ipv6/hop_by_hop.rb

@@ -11,7 +11,8 @@ module PacketGen
     class IPv6
       # @!parse
       #  # Option for {HopByHop} IPv6 extension header.
-      #  # @since 3.1.0 subclass of {BinStruct::AbstractTLV}
+      #  # @since 2.4.0
+      #  # @since 3.1.0 subclass of +BinStruct::AbstractTLV+
       #  class Option <AbstractTLV; end
       # @private
       Option = BinStruct::AbstractTLV.create
@@ -23,6 +24,7 @@ module PacketGen
           5 => 'router_alert'
         }.freeze
 
+        # Get human-readable string
         # @return [String]
         def to_human
           case type
@@ -35,13 +37,16 @@ module PacketGen
       end
       Option.define_type_enum Option::TYPES.invert
 
-      # Special option pad1, for {HopByHop} IPv6 extension header
+      # Special option pad1 (one-byte option), for {HopByHop} IPv6 extension header
       # @author Sylvain Daubert
+      # @since 2.4.0
       class Pad1 < BinStruct::Struct
         # @!attribute pad
-        # @return [Integer]
+        #   Pad1 option type
+        #   @return [Integer]
         define_attr :pad, BinStruct::Int8, default: 0
 
+        # Get human-readable string
         # @return [String]
         def to_human
           'pad1'
@@ -50,6 +55,7 @@ module PacketGen
 
       # Array of {Option}, for {HopByHop} IPv6 extension header
       # @author Sylvain Daubert
+      # @since 2.4.0
       class Options < BinStruct::Array
         set_of Option
 
@@ -96,18 +102,31 @@ module PacketGen
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       #
       # Hop-by-hop IPv6 extension header consists of:
-      # * a {#next} header field ({BinStruct::Int8}),
-      # * a {#length} field ({BinStruct::Int8}),
+      # * a {#next #next} header field (+BinStruct::Int8+),
+      # * a {#length #length} field (+BinStruct::Int8+),
       # * an {#options} field ({Options}),
-      # * and a {#body}, containing next header.
+      # * and a {#body #body}, containing next header.
+      # @example
+      #  pkt = PacketGen.gen('Eth').add('IPv6').add('IPv6::HopByHop').add('ICMPv6')
+      #  pkt.ipv6_hopbyhop.options << { type: 'router_alert', value: "\x00\x00".b }
       # @author Sylvain Daubert
+      # @since 2.4.0
       class HopByHop < Extension
         # redefine options field
         remove_attr :options
         # @!attribute options
-        #  Specific options of extension header
+        #  Specific HopByHop options
         #  @return [Options]
         define_attr_before :body, :options, Options, builder: ->(h, t) { t.new(length_from: -> { h.real_length - 2 }) }
+
+        # Generate binary string. Add padding if needed in {#options}, and update {#length} accordingly.
+        # @return [String]
+        # @since 2.4.0
+        # @since 4.1.0 Set {Extension#length}.
+        def to_s
+          calc_length
+          super
+        end
       end
     end
 

data/lib/packetgen/header/ipv6.rb

@@ -37,26 +37,27 @@ module PacketGen
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # A IPv6 header consists of:
-    # * a first 32-bit word ({#u32}, of {BinStruct::Int32} type) composed of:
+    # * a first 32-bit word ({#u32}, of +BinStruct::Int32+ type) composed of:
     #   * a 4-bit {#version} field,
     #   * a 8-bit {#traffic_class} field,
     #   * a 20-bit {#flow_label} field,
-    # * a payload length field ({#length}, {BinStruct::Int16} type}),
-    # * a next header field ({#next}, {BinStruct::Int8} type),
-    # * a hop-limit field ({#hop}, +Int8+ type),
+    # * a payload length field ({#length}, +BinStruct::Int16+ type}),
+    # * a next header field ({#next}, +BinStruct::Int8+ type),
+    # * a hop-limit field ({#hop}, +BinStruct::Int8+ type),
     # * a source address field ({#src}, {IPv6::Addr} type),
-    # * a destination address field ({#dst}, +IPv6::Addr+ type),
-    # * and a {#body} ({BinStruct::String} type).
+    # * a destination address field ({#dst}, {IPv6::Addr} type),
+    # * and a {#body} (+BinStruct::String+ type).
     #
-    # == Create a IPv6 header
+    # @example Create a IPv6 header
     #  # standalone
     #  ipv6 = PacketGen::Header::IPv6.new
     #  # in a packet
     #  pkt = PacketGen.gen('IPv6')
     #  # access to IPv6 header
-    #  pkt.ipv6   # => PacketGen::Header::IPv6
+    #  pkt.ipv6.class   # => PacketGen::Header::IPv6
     #
-    # == IPv6 attributes
+    # @example IPv6 attributes
+    #  ipv6 = PacketGen::Header::IPv6.new
     #  ipv6.u32 = 0x60280001
     #  # the same as
     #  ipv6.version = 6
@@ -68,9 +69,9 @@ module PacketGen
     #  ipv6.next = 6
     #  ipv6.src = '::1'
     #  ipv6.src                # => "::1"
-    #  ipv6[:src]              # => PacketGen::Header::IPv6::Addr
+    #  ipv6[:src].class        # => PacketGen::Header::IPv6::Addr
     #  ipv6.dst = '2001:1234:5678:abcd::123'
-    #  ipv6.body.read 'this is a body'
+    #  ipv6.body ='this is a body'
     #
     # == Add IPv6 extensions
     # In IPv6, optional extensions are encoded in separate headers that
@@ -84,6 +85,7 @@ module PacketGen
     #  # Add another header
     #  pkt.add('UDP')
     # @author Sylvain Daubert
+    # @author LemonTree55
     class IPv6 < Base; end
 
     require_relative 'ipv6/addr'
@@ -96,11 +98,14 @@ module PacketGen
       #  First 32-bit word of IPv6 header
       #  @return [Integer]
       # @!attribute version
-      #   @return [Integer] 4-bit version attribute
+      #   4-bit version attribute
+      #   @return [Integer]
       # @!attribute traffic_class
-      #   @return [Integer] 8-bit traffic_class attribute
+      #   8-bit traffic_class attribute
+      #   @return [Integer]
       # @!attribute flow_label
-      #   @return [Integer] 20-bit flow_label attribute
+      #    20-bit flow_label attribute
+      #   @return [Integer]
       define_bit_attr :u32, default: 0x60000000, version: 4, traffic_class: 8, flow_label: 20
       # @!attribute length
       #  16-bit word of IPv6 payload length
@@ -123,10 +128,11 @@ module PacketGen
       #  @return [Addr]
       define_attr :dst, Addr, default: '::1'
       # @!attribute body
-      #  @return [BinStruct::String,Header::Base]
+      #  IPv6 body
+      #  @return [BinStruct::String,Headerable]
       define_attr :body, BinStruct::String
 
-      # Compute length and set +len+ field
+      # Compute length and set {#length} field
       # @return [Integer]
       def calc_length
         Base.calculate_and_set_length self, header_in_size: false
@@ -141,7 +147,7 @@ module PacketGen
         sum
       end
 
-      # Send IPv6 packet on wire. All attributes.may be set (even {#version}).
+      # Send IPv6 packet on wire. All attributes may be set (even {#version}).
       # @param [String] _iface interface name (not used)
       # @return [void]
       # @since 3.0.0 no more limitations on +flow_label+, +length+ and +src+ fields.
@@ -168,7 +174,7 @@ module PacketGen
       end
 
       # Check version field
-      # @see [Base#parse?]
+      # @see Base#parse?
       def parse?
         version == 6
       end
@@ -197,15 +203,18 @@ module PacketGen
   module Header
     class IPv6
       class << self
+        # @private
         alias old_bind bind
 
         # Bind a upper header to IPv6 and its defined extension headers.
         # @see Base.bind
+        # @author LemonTree55
         def bind(header_klass, args={})
-          IPv6.old_bind header_klass, args
-          [IPv6::HopByHop].each do |klass|
-            klass.bind header_klass, args
-          end
+          IPv6.old_bind(header_klass, args)
+          IPv6.constants
+              .map { |cname| IPv6.const_get(cname) }
+              .select { |klass| klass.is_a?(Class) && (klass < Extension) }
+              .each { |klass| klass.bind(header_klass, args) }
         end
       end
     end

data/lib/packetgen/header/llc.rb

@@ -12,24 +12,28 @@ module PacketGen
     # Logical-Link Control header
     #
     # A LLC header consists of:
-    # * a {#dsap} ({BinStruct::Int8}),
-    # * a {#ssap} ({BinStruct::Int8}),
-    # * a {#control} ({BinStruct::Int8}),
-    # * and a {#body} (a {BinStruct::String} or another {Base} class).
+    # * a {#dsap} (+BinStruct::Int8+),
+    # * a {#ssap} (+BinStruct::Int8+),
+    # * a {#control} (+BinStruct::Int8+),
+    # * and a {#body} (a +BinStruct::String+ or another {Headerable} class).
     # @author Sylvain Daubert
     # @since 1.4.0
     class LLC < Base
       # @!attribute dsap
-      #  @return [Integer] 8-bit dsap value
+      #  8-bit Destination Service Access Point value
+      #  @return [Integer]
       define_attr :dsap, BinStruct::Int8
       # @!attribute ssap
-      #  @return [Integer] 8-bit ssap value
+      #  8-bit Source Service Access Point value
+      #  @return [Integer]
       define_attr :ssap, BinStruct::Int8
       # @!attribute control
-      #  @return [Integer] 8-bit control value
+      #  8-bit control value
+      #  @return [Integer]
       define_attr :control, BinStruct::Int8
       # @!attribute body
-      #  @return [BinStruct::String,Header::Base]
+      #  LLC body
+      #  @return [BinStruct::String,Headerable]
       define_attr :body, BinStruct::String
     end
     self.add_class LLC
@@ -38,20 +42,23 @@ module PacketGen
     # Sub-Network Access Protocol
     #
     # A SNAP header consists of:
-    # * a {#oui} ({BinStruct::OUI}),
-    # * a {#proto_id} ({BinStruct::Int16}),
-    # * and a {#body} (a {BinStruct::String} or another {Base} class).
+    # * a {#oui} (+BinStruct::OUI+),
+    # * a {#proto_id} (+BinStruct::Int16+),
+    # * and a {#body} (a +BinStruct::String+ or another {Headerable} class).
     # @author Sylvain Daubert
     # @since 1.4.0
     class SNAP < Base
       # @!attribute oui
+      #  If +00:00:00+, {#proto_id} is an EtherType. Else, {#proto_id} is specified by organization specified BY +OUI+.
       #  @return [BinStruct::OUI]
       define_attr :oui, BinStruct::OUI
       # @!attribute proto_id
-      #  @return [Integer] 16-bit protocol id
+      #  16-bit protocol id
+      #  @return [Integer]
       define_attr :proto_id, BinStruct::Int16
       # @!attribute body
-      #  @return [BinStruct::String,Header::Base]
+      #  SNAP header
+      #  @return [BinStruct::String,Headerable]
       define_attr :body, BinStruct::String
     end
     self.add_class SNAP

data/lib/packetgen/header/mdns.rb

@@ -21,12 +21,18 @@ module PacketGen
       # Fixup IP header according to RFC 6762:
       # * set ethernet multicast address to +01:00:5E:00:00:FB+ (for IPv4)
       #   or +33:33:00:00:00:FB+ (for IPv6),
-      # * set IPv4 address to 224.0.0.251 or IPv6 address to ff02::fb.
+      # * set IPv4 address to +224.0.0.251+ or IPv6 address to +ff02::fb+.
       # This method may be called as:
       #    # first way
       #    pkt.mdns.mdnsize
       #    # second way
-      #    pkt.mdnsize
+      #    pkt.
+      # @example
+      #   pkt = PacketGen.gen('Eth').add('IP').add('UDP').add('MDNS')
+      #   pkt.mdnsize
+      #   pkt.eth.dst   #=> "01:00:5e:00:00:fb"
+      #   pkt.ip.dst    #=> "224.0.0.251"
+      # @return [void]
       def mdnsize
         iph = ip_header(self)
         case iph
@@ -42,6 +48,7 @@ module PacketGen
       # @api private
       # @note This method is used internally by PacketGen and should not be
       #       directly called
+      # Add +#mdnsize+ method to +packet+. This method calls {#mdnsize}.
       # @since 2.7.0 Set UDP sport according to bindings, only if sport is 0.
       #  Needed by new bind API.
       def added_to_packet(packet)

data/lib/packetgen/header/mld.rb

@@ -8,7 +8,7 @@
 
 module PacketGen
   module Header
-    # This class supports MLDv1 (RFC 2710).
+    # This class supports Multicast Listener Discovery for IPv6 (RFC 2710).
     #
     # From RFC 2710, a MLD header has the following format:
     #    0                   1                   2                   3
@@ -26,23 +26,24 @@ module PacketGen
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # A MLD header consists of:
-    # * a {#max_resp_delay} field ({BinStruct::Int16} type),
-    # * a {#reserved} field ({BinStruct::Int16} type),
+    # * a {#max_resp_delay} field (+BinStruct::Int16+ type),
+    # * a {#reserved} field (+BinStruct::Int16+ type),
     # * a {#mcast_addr} field ({Header::IPv6::Addr} type),
     # * and a {#body} (unused for MLDv1).
     #
-    # == Create a MLD header
+    # @example Create a MLD header
     #  # standalone
     #  mld = PacketGen::Header::MLD.new
     #  # in a packet
     #  pkt = PacketGen.gen('IPv6').add('ICMPv6').add('MLD')
     #  # access to MLD header
-    #  pkt.mld    # => PacketGen::Header::MLD
+    #  pkt.mld.class    # => PacketGen::Header::MLD
     #
-    # == MLD attributes
-    #  pkt.icmpv6.type = 130       # ICMPv6 type 130 is MLD Multicast Listener Query
+    # @example MLD attributes
+    #  pkt = PacketGen.gen('IPv6').add('ICMPv6').add('MLD')
+    #  pkt.icmpv6.type = 130        # ICMPv6 type 130 is MLD Multicast Listener Query
     #  pkt.mld.max_resp_delay = 20
-    #  pkt.mld.group_addr = '::'
+    #  pkt.mld.mcast_addr = '::'
     # @author Sylvain Daubert
     # @since 2.4.0
     class MLD < Base
@@ -61,12 +62,13 @@ module PacketGen
       #  @return [IPv6::Addr]
       define_attr :mcast_addr, IPv6::Addr, default: '::'
       # @!attribute body
-      #  @return [String,Base]
+      #  @return [String,Headerable]
       define_attr :body, BinStruct::String
 
       # @api private
       # @note This method is used internally by PacketGen and should not be
       #       directly called
+      # This method adds +#mldize+ method to +packet+. This method calls {#mldize}.
       def added_to_packet(packet)
         mld_idx = packet.headers.size
         packet.instance_eval "def mldize() @headers[#{mld_idx}].mldize; end" # def mldize() @headers[3].mldize; end

data/lib/packetgen/header/mldv2/mcast_address_record.rb

@@ -81,14 +81,19 @@ module PacketGen
         define_attr :source_addr, IPv6::ArrayOfAddr,
                     builder: ->(h, t) { t.new(counter: h[:number_of_sources]) }
         # @!attribute aux_data
+        #  Auxiliary data
         #  @return [String]
         define_attr :aux_data, BinStruct::String,
                     builder: ->(h, t) { t.new(length_from: -> { h[:aux_data_len].to_i * 4 }) }
 
+        # Get human-readable type
+        # @return [String]
         def human_type
           self[:type].to_human
         end
 
+        # Get human-readable description
+        # @return [String]
         def to_human
           "#{human_type}(ma:#{multicast_addr}|src:#{source_addr.to_human})"
         end
@@ -99,7 +104,7 @@ module PacketGen
       class McastAddressRecords < BinStruct::Array
         set_of McastAddressRecord
 
-        # Separator used in {#to_human}.
+        # Separator used in +#to_human+.
         HUMAN_SEPARATOR = ';'
       end
     end