packetgen 4.0.0 → 4.1.0

data/lib/packetgen/header/ospfv3/ipv6_prefix.rb

@@ -51,7 +51,7 @@ module PacketGen
         define_attr :reserved, BinStruct::Int16
         # @!attribute prefix
         #  IPv6 Prefix as an array of 32-bit words
-        #  @return [Prefix]
+        #  @return [BinStruct::ArrayOfInt32]
         define_attr :prefix, BinStruct::ArrayOfInt32, builder: ->(h, t) { t.new(length_from: -> { h.length / 8 }) }
 
         # Get human-readable prefix
@@ -68,7 +68,10 @@ module PacketGen
         # Set prefix from a human-readable string. This method cannot set
         # {#options} field.
         # @param [String] str
-        # @return [void]
+        # @return [self]
+        # @example
+        #   prefix = PacketGen::Header::OSPFv3::IPv6Prefix.new.from_human("2000::/64")
+        #   prefix.to_human #=> "2000::/64"
         def from_human(str)
           ary, len = ary_and_prefix_len_from_str(str)
 
@@ -81,6 +84,7 @@ module PacketGen
             end
           end
           self.length = len
+          self
         end
 
         private

data/lib/packetgen/header/ospfv3/ls_ack.rb

@@ -23,18 +23,17 @@ module PacketGen
       # This paylod is implemented with only one field:
       # * {#lsas}, an {ArrayOfLSA} object.
       #
-      # == Create a LSAck payload
+      # @example Create a LSAck payload
       #   # standalone
       #   lsack = PacketGen::Header::OSPFv3::LSAck.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3').add('OSPFv3::LSAck')
+      #   pkt = PacketGen.gen('IPv6').add('OSPFv3').add('OSPFv3::LSAck')
       #   # access to LSAck payload
-      #   lasck = pkt.ospfv3_lsack    # => PacketGen::Header::OSPFv3::LSAck
+      #   lasck = pkt.ospfv3_lsack.class    # => PacketGen::Header::OSPFv3::LSAck
       #
-      # == Adding LSA headers to a LSAck payload
+      # @example Adding LSA headers to a LSAck payload
+      #   lsack = PacketGen::Header::OSPFv3::LSAck.new
       #   lsack.lsas << { type: 'Router', age: 40, link_state_id: '0.0.0.1', advertising_router: '1.1.1.1', sequence_number: 42, checksum: 0x1234, length: 56 }
-      #   # a header may also be set from an existing lsa
-      #   lasck.lsas << existing_lsa.to_lsa_header
       # @author Sylvain Daubert
       class LSAck < Base
         # @!attribute lsas

data/lib/packetgen/header/ospfv3/ls_request.rb

@@ -22,10 +22,10 @@ module PacketGen
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       #
       # It is composed of:
-      # * a 16-bit {#reserved} field,
-      # * a 16-bit {#type} field,
-      # * a 32-bit {#link_state_id} field,
-      # * and a 32-bit {#advertising_router} field.
+      # * a 16-bit {#reserved} field (+BinStruct::Int16+),
+      # * a 16-bit {#type} field (+BinStruct::Int16+),
+      # * a 32-bit {#link_state_id} field ({IP::Addr}),
+      # * and a 32-bit {#advertising_router} field ({IP::Addr}).
       # @author Sylvain Daubert
       class LSR < BinStruct::Struct
         include BinStruct::Structable
@@ -60,8 +60,7 @@ module PacketGen
         end
       end
 
-      # This class defines a specialized {BinStruct::Array array} to handle series
-      # of {LSR LSRs}.
+      # This class defines a specialized array to handle series of {LSR LSRs}.
       # @author Sylvain Daubert
       class ArrayOfLSR < BinStruct::Array
         set_of LSR
@@ -83,17 +82,18 @@ module PacketGen
       # This paylod is implemented as a unique field: {#lsrs}, which is an
       # {ArrayOfLSR} object.
       #
-      # == Create a LSRequest payload
+      # @example Create a LSRequest payload
       #   # standalone
       #   lsr = PacketGen::Header::OSPFv3::LSRequest.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3').add('OSPFv3::LSRequest')
+      #   pkt = PacketGen.gen('IPv6').add('OSPFv3').add('OSPFv3::LSRequest')
       #   # make IPv6 header correct for OSPF
       #   pkt.ospfize
       #   # access to LSRequest payload
-      #   pkt.ospfv3_lsrequest    # => PacketGen::Header::OSPFv3::LSRequest
+      #   pkt.ospfv3_lsrequest.class    # => PacketGen::Header::OSPFv3::LSRequest
       #
-      # == Add LSA requests to a LSRequest
+      # @example Add LSA requests to a LSRequest
+      #   lsr = PacketGen::Header::OSPFv3::LSRequest.new
       #   lsr.lsrs << { type: 'Router', link_state_id: '0.0.0.1', advertising_router: '1.1.1.1'}
       # @author Sylvain Daubert
       class LSRequest < Base

data/lib/packetgen/header/ospfv3/ls_update.rb

@@ -23,22 +23,22 @@ module PacketGen
       #   |                              ...                              |
       #
       # This paylod is implemented with two fields:
-      # * {#lsas_count}, a {BinStruct::Int32} field,
+      # * {#lsas_count}, a +BinStruct::Int32+ field,
       # * and {#lsas}, an {ArrayOfLSA} object.
       #
-      # == Create a LSUpdate payload
+      # @example Create a LSUpdate payload
       #   # standalone
       #   lsu = PacketGen::Header::OSPFv3::LSUpdate.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3').add('OSPFv3::LSUpdate')
+      #   pkt = PacketGen.gen('IPv6').add('OSPFv3').add('OSPFv3::LSUpdate')
       #   # make IPv6 header correct for OSPF
       #   pkt.ospfize
       #   # access to LSUpdate payload
-      #   lsu = pkt.ospfv3_lsupdate    # => PacketGen::Header::OSPFv3::LSUpdate
+      #   lsu = pkt.ospfv3_lsupdate.class    # => PacketGen::Header::OSPFv3::LSUpdate
       #
-      # == Add LSAs to a LSUpdate payload
-      # Adding LSAs with {ArrayOfLSA#<< ArrayOfLSA#<<} automagically update
-      # {#lsas_count}. To not update it, use {ArrayOfLSA#push ArrayOfLSA#push}.
+      # @example Add LSAs to a LSUpdate payload
+      #   lsu = PacketGen::Header::OSPFv3::LSUpdate.new
+      #   # Adding LSAs with #<< automagically update #lsas_count. To not update it, use #push.
       #   lsu.lsas << { type: 'Router', age: 40, link_state_id: '0.0.0.1', advertising_router: '1.1.1.1', sequence_number: 42 }
       #   lsu.lsas_count     #=> 1
       #   # add a link to Router LSA

data/lib/packetgen/header/ospfv3/lsa.rb

@@ -15,24 +15,33 @@ module PacketGen
         include BinStruct::Structable
 
         # @!attribute type
+        #  Kind of interface being described. One of the following:
+        #    * 1: Point-to-point connection to another router
+        #    * 2: Connection to a transit network
+        #    * 4: Virtual link
         #  @return [Integer]
         define_attr :type, BinStruct::Int8
         # @!attribute reserved
         #  @return [Integer]
         define_attr :reserved, BinStruct::Int8, default: 0
         # @!attribute metric
+        #  Cost of using this router interface.
         #  @return [Integer]
         define_attr :metric, BinStruct::Int16
         # @!attribute interface_id
+        #  ID for the interface being described.
         #  @return [Integer]
         define_attr :interface_id, BinStruct::Int32
         # @!attribute neighbor_interface_id
+        #  Interface ID the neighbor router has associated with this link.
         #  @return [Integer]
         define_attr :neighbor_interface_id, BinStruct::Int32
         # @!attribute neighbor_router_id
+        #  Router ID of the neighbor router.
         #  @return [String]
         define_attr :neighbor_router_id, IP::Addr
 
+        # Human-readable description
         # @return [String]
         def to_human
           "Link<type:#{type},metric:#{metric},id:#{interface_id}," \
@@ -40,7 +49,7 @@ module PacketGen
         end
       end
 
-      # This class defines a specialized {BinStruct::Array array} to handle series
+      # This class defines a specialized +BinStruct::Array+ to handle series
       # of {Link Links}.
       # @author Sylvain Daubert
       class ArrayOfLink < BinStruct::Array
@@ -62,8 +71,8 @@ module PacketGen
       #
       # A LSA router payload is composed of:
       # * a header (see methods inherited from {LSAHeader}),
-      # * a 8-bit flag word {#flags} ({BinStruct::Int8}),
-      # * a 24-bit {#options} field ({BinStruct::Int24}),
+      # * a 8-bit flag word {#flags} (+BinStruct::Int8+),
+      # * a 24-bit {#options} field (+BinStruct::Int24+),
       # * and an array of {#links} ({ArrayOfLink}).
       # @author Sylvain Daubert
       class LSARouter < LSAHeader
@@ -71,17 +80,22 @@ module PacketGen
         #  8-bit flag word
         #  @return [Integer]
         # @!attribute nt_flag
+        #  If set, the router is an NSSA border router that is translating NSSA-LSAs into AS-external-LSAs.
         #  @return [Integer]
         # @!attribute v_flag
+        #  If set, router is an endpoint or one or many  fully adjacent virtual links.
         #  @return [Integer]
         # @!attribute e_flag
+        #  If set, router is an AS boundary router.
         #  @return [Integer]
         # @!attribute b_flag
+        #  If set, router is an area border router.
         #  @return [Integer]
         define_bit_attr :flags, zz: 3, nt_flag: 1, x_flag: 1, v_flag: 1, e_flag: 1, b_flag: 1
         # @!macro define_ospfv3_options
         OSPFv3.define_options(self)
         # @attribute links
+        #  Router interfaces, as a list of {Link} objects.
         #  @return [ArrayOfLink]
         define_attr :links, ArrayOfLink, builder: ->(h, t) { t.new(length_from: -> { h.length - h.offset_of(:links) }) }
       end
@@ -109,8 +123,8 @@ module PacketGen
       # This class handles OSPFv3 LSA Intra-Area-Prefix payloads.
       #
       # An Intra-Area-Prefix payloads is composed of:
-      # * a 16-bit {#prefix_count} field ({BinStruct::Int16}),
-      # * a 16-bit {#ref_ls_type} field ({BinStruct::Int16Enum}),
+      # * a 16-bit {#prefix_count} field (+BinStruct::Int16+),
+      # * a 16-bit {#ref_ls_type} field (+BinStruct::Int16Enum+),
       # * a 32-bit {#ref_link_state_id} ({IP::Addr}),
       # * a 32-bit {#ref_advertising_router} ({IP::Addr}),
       # * and an array of {IPv6Prefix} ({#prefixes}, {ArrayOfIPv6Prefix}). In
@@ -150,10 +164,10 @@ module PacketGen
       # This class handles OSPFv3 LSA Link payloads.
       #
       # A Link payloads is composed of:
-      # * a 8-bit {#router_priority} field ({BinStruct::Int8}),
-      # * a 24-bit {#options} field ({BinStruct::Int24}),
+      # * a 8-bit {#router_priority} field (+BinStruct::Int8+),
+      # * a 24-bit {#options} field (+BinStruct::Int24+),
       # * a 128-bit IPv6 {#interface_addr} ({IPv6::Addr}),
-      # * a 32-bit {#prefix_count} field ({BinStruct::Int32}),
+      # * a 32-bit {#prefix_count} field (+BinStruct::Int32+),
       # * and an array of {IPv6Prefix} ({#prefixes}, {ArrayOfIPv6Prefix}).
       # @author Sylvain Daubert
       class LSALink < LSAHeader
@@ -178,7 +192,7 @@ module PacketGen
         define_attr :prefixes, ArrayOfIPv6Prefix, builder: ->(h, t) { t.new(counter: h[:prefix_count]) }
       end
 
-      # This class defines a specialized {BinStruct::Array array} to handle series
+      # This class defines a specialized +BinStruct::Array+ to handle series
       # of {LSA LSAs} or {LSAHeader LSAHeaders}. It recognizes known LSA types
       # and infers correct type.
       # @author Sylvain Daubert

data/lib/packetgen/header/ospfv3/lsa_header.rb

@@ -76,7 +76,7 @@ module PacketGen
         #  @return [Integer]
         define_attr :length, BinStruct::Int16
 
-        # Compute and set Fletcher-16 checksum on LSA
+        # Compute and set Fletcher-16 {#checksum} on LSA
         # @return [Integer]
         def calc_checksum
           c0 = c1 = 0
@@ -94,7 +94,7 @@ module PacketGen
           self.checksum = (x << 8) | y
         end
 
-        # Compute length and set +length+ field
+        # Compute length and set {#length} field
         # @return [Integer]
         def calc_length
           self.length = Base.calculate_and_set_length(self)
@@ -106,6 +106,7 @@ module PacketGen
           self[:type].to_human
         end
 
+        # Get human-readable description
         # @return [String]
         def to_human
           "LSA<#{human_type},#{link_state_id},#{advertising_router}>"

data/lib/packetgen/header/ospfv3.rb

@@ -24,45 +24,47 @@ module PacketGen
     #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # An OSPFv3 header consists of:
-    # * a {#version} field ({BinStruct::Int8}),
-    # * a {#type} field ({BinStruct::Int8Enum}),
-    # * a {#length} field ({BinStruct::Int16}). The length includes the header,
-    # * a {#router_id} field ({BinStruct::Int32}),
-    # * an {#area_id} field ({BinStruct::Int32}),
-    # * a {#checksum} field ({BinStruct::Int16}),
-    # * an {#instance_id} field ({BinStruct::Int8}),
-    # * a {#reserved} field ({BinStruct::Int8}),
-    # * and a {#body} ({BinStruct::String}).
+    # * a {#version} field (+BinStruct::Int8+),
+    # * a {#type} field (+BinStruct::Int8Enum+),
+    # * a {#length} field (+BinStruct::Int16+). The length includes the header,
+    # * a {#router_id} field (+BinStruct::Int32+),
+    # * an {#area_id} field (+BinStruct::Int32+),
+    # * a {#checksum} field (+BinStruct::Int16+),
+    # * an {#instance_id} field (+BinStruct::Int8+),
+    # * a {#reserved} field (+BinStruct::Int8+),
+    # * and a {#body} (+BinStruct::String+ or {Headerable}).
     #
-    # == Create an OSPFv3 header
+    # == OSPFv3 body
+    # OSPFv3 {#body} should contain OSPF payload for given {#type}:
+    # * {OSPFv3::Hello},
+    # * {OSPFv3::DbDescription},
+    # * {OSPFv3::LSRequest},
+    # * {OSPFv3::LSUpdate},
+    # * or {OSPFv3::LSAck}.
+    #
+    # @example Create an OSPFv3 header
     #   # standalone
     #   ospf = PacketGen::Header::OSPFv3.new
     #   # in a packet
-    #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3')
+    #   pkt = PacketGen.gen('IPv6').add('OSPFv3')
     #   # make IPv6 header correct for OSPF
     #   pkt.ospfize
     #   # or make it correct with specific destination address
     #   pkt.ospfize(dst: :all_spf_routers)
     #   # access to OSPF header
-    #   pkt.ospfv3    # => PacketGen::Header::OSPFv3
-    #
-    # == OSPFv3 attributes
-    #  ospf.version              # => 3
-    #  ospf.type = 'LS_ACK'      # or 5
-    #  ospf.length = 154
-    #  ospf.router_id = 0xc0a80001
-    #  ospf.area_id = 1
-    #  ospf.checksum = 0xabcd
-    #  ospf.instance_id = 0
+    #   pkt.ospfv3.class    # => PacketGen::Header::OSPFv3
     #
-    # == OSPFv3 body
-    # OSPFv3 {#body} should contain OSPF payload for given {#type}:
-    # * {OSPFv3::Hello},
-    # * {OSPFv3::DbDescription},
-    # * {OSPFv3::LSRequest},
-    # * {OSPFv3::LSUpdate},
-    # * or {OSPFv3::LSAck}.
+    # @example OSPFv3 attributes
+    #   ospf = PacketGen::Header::OSPFv3.new
+    #   ospf.version              # => 3
+    #   ospf.type = 'LS_ACK'      # or 5
+    #   ospf.length = 154
+    #   ospf.router_id = 0xc0a80001
+    #   ospf.area_id = 1
+    #   ospf.checksum = 0xabcd
+    #   ospf.instance_id = 0
     # @author Sylvain Daubert
+    # @author LemonTree55
     # @since 2.5.0
     class OSPFv3 < Base
       # IP protocol number for OSPF
@@ -80,7 +82,7 @@ module PacketGen
       #  @return [Integer]
       define_attr :type, BinStruct::Int8Enum, enum: TYPES
       # @!attribute length
-      #  16-bit OSPF packet length
+      #  16-bit OSPF packet length. Header is included in length
       #  @return [Integer]
       define_attr :length, BinStruct::Int16
       # @!attribute router_id
@@ -104,7 +106,8 @@ module PacketGen
       #  @return [Integer]
       define_attr :reserved, BinStruct::Int8, default: 0
       # @!attribute body
-      #  @return [String,Base]
+      #  OSPFv3 body
+      #  @return [String,Headerable]
       define_attr :body, BinStruct::String
 
       # @api private
@@ -142,12 +145,13 @@ module PacketGen
       # @api private
       # @note This method is used internally by PacketGen and should not be
       #       directly called
+      # Add +#ospfize+ method to +packet+. This method calls {#ospfize}.
       def added_to_packet(packet)
         ospf_idx = packet.headers.size
         packet.instance_eval "def ospfize(**kwargs) @headers[#{ospf_idx}].ospfize(**kwargs); end" # def ospfize(**kwargs) @headers[2].ospfize(**kwargs); end
       end
 
-      # Compute checksum and set +checksum+ field
+      # Compute checksum and set {#checksum} attribute
       # @return [Integer]
       def calc_checksum
         ipv6 = ip_header(self)
@@ -164,7 +168,7 @@ module PacketGen
         self[:type].to_human
       end
 
-      # Compute length and set +length+ field
+      # Compute length and set {#length} attribute
       # @return [Integer]
       def calc_length
         self[:length].value = Base.calculate_and_set_length(self)
@@ -179,8 +183,8 @@ module PacketGen
       #    pkt.ospfv3.ospfize
       #    # second way
       #    pkt.ospfize
-      # @param [String,Symbol,nil] dst destination address. May be a dotted IP
-      #   address (by example '224.0.0.5') or a Symbol (+:all_spf_routers+ or
+      # @param [String,Symbol,nil] dst destination address. May be a coloned IP
+      #   address (by example +1::1234:5+) or a Symbol (+:all_spf_routers+ or
       #   +:all_d_routers+)
       # @return [void]
       def ospfize(dst: nil)

data/lib/packetgen/header/sctp/chunk.rb

@@ -11,7 +11,7 @@ require_relative 'padded32'
 module PacketGen
   module Header
     class SCTP
-      # BaseChunk class, defining SCTP chunk common fields
+      # Base SCTP chunk class, defining SCTP chunk common fields.
       #   0                   1                   2                   3
       #   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -61,13 +61,13 @@ module PacketGen
           str << '>'
         end
 
+        # Get human-readable type
         # @return [::String,Integer]
         def human_type
           self[:type].to_human
         end
 
-        # Calculate and set chunk length
-        # @todo do not count last parameter padding
+        # Calculate and set chunk {#length}
         # @return [Integer]
         def calc_length
           self.length = to_s(no_padding: true).size
@@ -124,7 +124,7 @@ module PacketGen
         define_attr :body, BinStruct::String, builder: ->(h, t) { t.new(length_from: -> { h.length - 4 }) }
       end
 
-      # Data chunk
+      # Data chunk. This SCTP chunk embeds user data.
       #   0                   1                   2                   3
       #   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -143,7 +143,7 @@ module PacketGen
       # @author Sylvain Daubert
       class DataChunk < BaseChunk
         # @!attribute tsn
-        #   32-bit TSN for this DATA chunk
+        #   32-bit Transmission Sequence Number for this DATA chunk
         #   @return [Integer]
         define_attr :tsn, BinStruct::Int32
         # @!attribute stream_id
@@ -159,7 +159,7 @@ module PacketGen
         #  @return [Integer]
         define_attr :ppid, BinStruct::Int32
         # @!attribute body
-        #  SCTP chunk value
+        #  User data
         #  @return [String]
         define_attr :body, BinStruct::String, builder: ->(h, t) { t.new(length_from: -> { h.length - 4 }) }
 
@@ -168,13 +168,13 @@ module PacketGen
         #  IMMEDIATE flag
         #  @return [Integer]
         # @!attribute flag_u
-        #  UNORDERED flag
+        #  UNORDERED flag. If set, no Stream Sequence Number is assigned to this chunk.
         #  @return [Integer]
         # @!attribute flag_b
-        #  BEGINNING fragment flag
+        #  BEGINNING fragment flag. If set, indicate the first fragment of a user message.
         #  @return [Integer]
         # @!attribute flag_e
-        #  ENDING fragment flag
+        #  ENDING fragment flag. If set, indicate the last fragment of a user message.
         #  @return [Integer]
         define_bit_attr_after :type, :flags, flag_res: 4, flag_i: 1, flag_u: 1, flag_b: 1, flag_e: 1
 
@@ -190,7 +190,7 @@ module PacketGen
         end
       end
 
-      # Init Chunk
+      # Init Chunk. This chunk is used to initiate an SCTP association.
       #         0                   1                   2                   3
       #   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -241,13 +241,14 @@ module PacketGen
         end
 
         # Calculate lengths, including parameters ones.
-        # @return [void]
+        # @return [Integer] chunk length
         def calc_length
           parameters.each(&:calc_length)
           super
         end
 
-        # @return [::String]
+        # Get human-redable description.
+        # @return [String]
         def to_human
           str = "<chunk:#{human_type}"
           flags_str = flags_to_human
@@ -345,6 +346,17 @@ module PacketGen
         end
       end
 
+      # @!parse
+      #  # Heartbeat Information.
+      #  # @author LemonTree55
+      #  # @since 4.1.0 Replace +HeartbeatInfoParameter+
+      #  class HeartbeatInfo < BinStruct::AbstractTLV; end
+      HearbeatInfo = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16Enum,
+                                                   length_class: BinStruct::Int16,
+                                                   attr_in_length: 'TLV')
+      HearbeatInfo.define_type_enum({ 'HearbeatInfo' => 1 }.freeze)
+      HearbeatInfo.define_type_default('HearbeatInfo')
+
       # Heartbeat Request Chunk
       #         0                   1                   2                   3
       #   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
@@ -356,11 +368,14 @@ module PacketGen
       #  \                                                               \
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # @author Sylvain Daubert
+      # @author LemonTree55
+      # @since 3.4.0
+      # @since 4.1.0 {#info} is now a {HeartbeatInfo}
       class HeartbeatChunk < BaseChunk
         # @!attribute info
-        #   Array of Heartbeat information TLV.
-        #   @return [BinStruct::ArrayOfInt32]
-        define_attr :info, HearbeatInfoParameter
+        #   Heartbeat information TLV.
+        #   @return [HearbeatInfo]
+        define_attr :info, HearbeatInfo
 
         def initialize(options={})
           options[:type] = BaseChunk::TYPES['HEARTBEAT'] unless options.key?(:type)
@@ -379,6 +394,8 @@ module PacketGen
       #  \                                                               \
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # @author Sylvain Daubert
+      # @since 3.4.0
+      # @since 4.1.0 {#info} is now a {HeartbeatInfo}
       class HeartbeatAckChunk < HeartbeatChunk
         def initialize(options={})
           options[:type] = BaseChunk::TYPES['HEARTBEAT_ACK'] unless options.key?(:type)
@@ -399,7 +416,8 @@ module PacketGen
       # @author Sylvain Daubert
       class ErrorChunk < BaseChunk
         # @!attribute error_causes
-        #  @return [ArrayofError]
+        #  Causes for this error chunk
+        #  @return [ArrayOfError]
         define_attr :error_causes, ArrayOfError
 
         def initialize(options={})
@@ -407,13 +425,14 @@ module PacketGen
           super
         end
 
-        # Calculate lengths, including parameters ones.
+        # Calculate lengths, including causes ones.
         # @return [void]
         def calc_length
           error_causes.each(&:calc_length)
           super
         end
 
+        # Get human-readable description
         # @return [::String]
         def to_human
           str = "<chunk:#{human_type}"
@@ -438,6 +457,7 @@ module PacketGen
       class AbortChunk < ErrorChunk
         remove_attr :flags
         # @!attribute flag_t
+        #  Reflecting bit
         #  @return [Integer]
         define_bit_attr_after :type, :flags, flag_res: 7, flag_t: 1
 
@@ -502,6 +522,7 @@ module PacketGen
       # @author Sylvain Daubert
       class CookieEchoChunk < BaseChunk
         # @!attribute cookie
+        #  Cookie value
         #  @return [String]
         define_attr :cookie, BinStruct::String