packetgen 4.0.0 → 4.1.0

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

@@ -57,23 +57,23 @@ module PacketGen
       #  *                                                               *
       #  |                                                               |
       #  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      # +type+, +code+ and +checksum+ are attributes.from {ICMPv6} header.
+      # +type+, +code+ and +checksum+ are attributes from {ICMPv6} header.
       #
-      # MLQ attributes.are:
-      # * {#max_resp_code #max_resp_code} ({BinStruct::Int16}),
-      # * {#reserved #reserved} ({BinStruct::Int16}),
+      # MLQ attributes are:
+      # * {#max_resp_code #max_resp_code} (+BinStruct::Int16+),
+      # * {#reserved #reserved} (+BinStruct::Int16+),
       # * {#mcast_addr #mcast_addr} ({IPv6::Addr}),
-      # * {#flags} ({BinStruct::Int8}), with sub-fields:
+      # * {#flags} (+BinStruct::Int8+), with sub-fields:
       #   * a 4-bit {#flag_resv} field,
       #   * a 1-bit {#flag_s} boolean,
       #   * a 3-bit {#flag_qrv} field,
-      # * {#qqic} ({BinStruct::Int8}),
-      # * {#number_of_sources} ({BinStruct::Int16}),
+      # * {#qqic} (+BinStruct::Int8+),
+      # * {#number_of_sources} (+BinStruct::Int16+),
       # * and {#source_addr}, a {IPv6::ArrayOfAddr}.
       #
       # == Max Resp Delay
       # Max Resp Delay is the real delay value. Max Resp Code is the encoded
-      # delay. So {#max_resp_delay} and {#max_resp_code} attributes reflect this
+      # delay. So {#max_resp_delay} and {#max_resp_code #max_resp_code} attributes reflect this
       # difference.
       # @author Sylvain Daubert
       class MLQ < MLD

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

@@ -38,11 +38,11 @@ module PacketGen
       #   .                                                               .
       #   |                                                               |
       #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-      # +type+, +code+ and +checksum+ are attributes.from {ICMPv6} header.
+      # +type+, +code+ and +checksum+ are attributes from {ICMPv6} header.
       #
-      # MLR attributes.are:
-      # * {#reserved} ({BinStruct::Int16}),
-      # * {#number_of_mar} (number of mcast address records, {BinStruct::Int16}),
+      # MLR attributes are:
+      # * {#reserved} (+BinStruct::Int16+),
+      # * {#number_of_mar} (number of mcast address records, +BinStruct::Int16+),
       # * {#records} ({McastAddressRecords}).
       # @author Sylvain Daubert
       class MLR < Base

data/lib/packetgen/header/mldv2.rb

@@ -8,7 +8,7 @@
 
 module PacketGen
   module Header
-    # This module contains all MLDv2 specific classes.
+    # This module contains all Multicast Listener Discovery Version 2 (MLDv2) specific classes.
     # @author Sylvain Daubert
     # @since 2.4.0
     module MLDv2

data/lib/packetgen/header/ospfv2/db_description.rb

@@ -31,24 +31,26 @@ module PacketGen
       #   |                              ...                              |
       #
       # A DB description payload is composed of:
-      # * a 16-bit {#mtu} field ({BinStruct::Int16}),
-      # * a 8-bit {#options} field ({BinStruct::Int8}),
-      # * a 8-bit {#flags} field ({BinStruct::Int8}). Supported flags are:
+      # * a 16-bit {#mtu} field (+BinStruct::Int16+),
+      # * a 8-bit {#options} field (+BinStruct::Int8+),
+      # * a 8-bit {#flags} field (+BinStruct::Int8+). Supported flags are:
       #   * {i_flag},
       #   * {m_flag},
       #   * {ms_flag},
-      # * a 32-bit {#sequence_number} field ({BinStruct::Int32}),
+      # * a 32-bit {#sequence_number} field (+BinStruct::Int32+),
       # * and an array of {LSAHeader LSAHeaders} ({#lsas}, {ArrayOfLSA}).
       #
-      # == Create a DbDescription payload
+      # @example Create a DbDescription payload
       #   # standalone
       #   dbd = PacketGen::Header::OSPFv2::DbDescription.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2').add('OSPFv2::DbDescription')
+      #   pkt = PacketGen.gen('IP').add('OSPFv2').add('OSPFv2::DbDescription')
+      #   pkt.ospfize
       #   # access to DbDescription payload
-      #   pkt.ospfv2_dbdescription    # => PacketGen::Header::OSPFv2::DbDescription
+      #   pkt.ospfv2_dbdescription.class    # => PacketGen::Header::OSPFv2::DbDescription
       #
-      # == DbDescription attributes
+      # @example DbDescription attributes
+      #   dbd = PacketGen::Header::OSPFv2::DbDescription.new
       #   dbd.mtu = 1500
       #   # set options. Options may also be set one by one with {#mt_opt},
       #   # {#e_opt}, {#mc_opt}, {#n_opt}, {#l_opt}, {#dc_opt}, {#o_opt} and {#dn_opt}
@@ -57,8 +59,6 @@ module PacketGen
       #   dbd.seqnum = 0x800001
       #   # add a LSA Router header
       #   dbd.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
-      #   dbd.lsas << existing_lsa.to_lsa_header
       # @author Sylvain Daubert
       class DbDescription < Base
         # @!attribute mtu

data/lib/packetgen/header/ospfv2/hello.rb

@@ -29,25 +29,26 @@ module PacketGen
       #   |                              ...                              |
       # A HELLO payload consists of:
       # * a {#network_mask} field ({IP::Addr}),
-      # * a {#hello_interval} field ({BinStruct::Int16}),
-      # * an {#options} field ({BinStruct::Int8}),
-      # * a {#priority} field ({BinStruct::Int8}),
-      # * a {#dead_interval} field ({BinStruct::Int32}),
+      # * a {#hello_interval} field (+BinStruct::Int16+),
+      # * an {#options} field (+BinStruct::Int8+),
+      # * a {#priority} field (+BinStruct::Int8+),
+      # * a {#dead_interval} field (+BinStruct::Int32+),
       # * a {#designated_router} field ({IP::Addr}),
       # * a {#backup_designated_router} field ({IP::Addr}),
       # * a {#neighbors} array containing neighbors as {IP::Addr}.
       #
-      # == Create a HELLO payload
+      # @example Create a HELLO payload
       #   # standalone
       #   hello = PacketGen::Header::OSPFv2::Hello.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2').add('OSPFv2::Hello')
+      #   pkt = PacketGen.gen('IP').add('OSPFv2').add('OSPFv2::Hello')
       #   # make IP header correct for OSPF
       #   pkt.ospfize
       #   # access to Hello payload
-      #   pkt.ospfv2_hello    # => PacketGen::Header::OSPFv2::Hello
+      #   pkt.ospfv2_hello.class    # => PacketGen::Header::OSPFv2::Hello
       #
-      # == HELLO attributes
+      # @example HELLO attributes
+      #   hello = PacketGen::Header::OSPFv2::Hello.new
       #   hello.network_mask = '255.255.255.0'
       #   hello.hello_interval = 10
       #   hello.options = 0
@@ -82,12 +83,12 @@ module PacketGen
         #  @return [Integer]
         define_attr :dead_interval, BinStruct::Int32
         # @!attribute designated_router
-        #  The identity of the Designated Router for this network, in the
+        #  The identity (as an IP address) of the Designated Router for this network, in the
         #  view of the sending router.
         #  @return [String]
         define_attr :designated_router, IP::Addr
         # @!attribute backup_designated_router
-        #  The identity of the Backup Designated Router for this network,
+        #  The identity (as an IP address) of the Backup Designated Router for this network,
         #  in the view of the sending router.
         #  @return [String]
         define_attr :backup_designated_router, IP::Addr

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

@@ -28,18 +28,17 @@ module PacketGen
       # This paylod is implemented as a unique field: {#lsas}, which is an
       # {ArrayOfLSA} object.
       #
-      # == Create a LSAck payload
+      # @example Create a LSAck payload
       #   # standalone
       #   lsack = PacketGen::Header::OSPFv2::LSAck.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2').add('OSPFv2::LSAck')
+      #   pkt = PacketGen.gen('IP').add('OSPFv2').add('OSPFv2::LSAck')
       #   # access to LSAck payload
-      #   lasck = pkt.ospfv2_lsack    # => PacketGen::Header::OSPFv2::LSAck
+      #   lasck = pkt.ospfv2_lsack.class   # => PacketGen::Header::OSPFv2::LSAck
       #
-      # == Adding LSA headers to a LSAck payload
+      # @example Adding LSA headers to a LSAck payload
+      #   lsack = PacketGen::Header::OSPFv2::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/ospfv2/ls_request.rb

@@ -9,7 +9,7 @@
 module PacketGen
   module Header
     class OSPFv2
-      # This class handle a LS request, which is composed 3 {BinStruct::Int32} fields:
+      # This class handle a LS request, which is composed 3 +BinStruct::Int32+ fields:
       # * {#type},
       # * {#link_state_id},
       # * and {#advertising_router}.
@@ -43,7 +43,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 {LSR LSRs}.
       # @author Sylvain Daubert
       class ArrayOfLSR < BinStruct::Array
@@ -65,17 +65,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::OSPFv2::LSRequest.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2').add('OSPFv2::LSRequest')
+      #   pkt = PacketGen.gen('IP').add('OSPFv2').add('OSPFv2::LSRequest')
       #   # make IP header correct for OSPF
       #   pkt.ospfize
       #   # access to LSRequest payload
-      #   pkt.ospfv2_lsrequest    # => PacketGen::Header::OSPFv2::LSRequest
+      #   pkt.ospfv2_lsrequest.class    # => PacketGen::Header::OSPFv2::LSRequest
       #
-      # == Add LSA requests to a LSRequest
+      # @example Add LSA requests to a LSRequest
+      #   lsr = PacketGen::Header::OSPFv2::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/ospfv2/ls_update.rb

@@ -22,22 +22,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::OSPFv2::LSUpdate.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2').add('OSPFv2::LSUpdate')
+      #   pkt = PacketGen.gen('IP').add('OSPFv2').add('OSPFv2::LSUpdate')
       #   # make IP header correct for OSPF
       #   pkt.ospfize
       #   # access to LSUpdate payload
-      #   lsu = pkt.ospfv2_lsupdate    # => PacketGen::Header::OSPFv2::LSUpdate
+      #   lsu = pkt.ospfv2_lsupdate.class    # => PacketGen::Header::OSPFv2::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::OSPFv2::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/ospfv2/lsa.rb

@@ -45,7 +45,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 {TosMetric TOS metrics}.
       # @author Sylvain Daubert
       class ArrayOfTosMetric < BinStruct::Array
@@ -58,18 +58,27 @@ module PacketGen
         include BinStruct::Structable
 
         # @!attribute id
+        #  Identify the link
         #  @return [IP::Addr]
         define_attr :id, IP::Addr
         # @!attribute data
+        #  Link data
         #  @return [IP::Addr]
         define_attr :data, IP::Addr
         # @!attribute type
+        #  Link type.
+        #  * 1: Point-to-point connection to another router
+        #  * 2: Connection to a transit network
+        #  * 3: Connection to a stub network
+        #  * 4: Virtual link
         #  @return [Integer]
         define_attr :type, BinStruct::Int8
         # @!attribute tos_count
+        #  Count of #{#tos TOS metrics}
         #  @return [Integer]
         define_attr :tos_count, BinStruct::Int8
         # @!attribute metric
+        #  The cost of using this router link
         #  @return [Integer]
         define_attr :metric, BinStruct::Int16
         # @!attribute tos
@@ -77,13 +86,14 @@ module PacketGen
         #  @return [ArrayOfTosMetric]
         define_attr :tos, ArrayOfTosMetric, builder: ->(h, t) { t.new(counter: h[:tos_count]) }
 
+        # Get human-readable description
         # @return [String]
         def to_human
           "<type:#{type},metric:#{metric},id:#{id},data:#{data}>"
         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
@@ -94,8 +104,8 @@ module PacketGen
       #
       # A LSA router payload is composed of:
       # * a header (see methods inherited from {LSAHeader}),
-      # * a 16-bit flag word {#u16} ({BinStruct::Int16}),
-      # * a 16-bit {#link_count} field ({BinStruct::Int16}),
+      # * a 16-bit flag word {#u16} (+BinStruct::Int16+),
+      # * a 16-bit {#link_count} field (+BinStruct::Int16+),
       # * an array of {#links} ({ArrayOfLink}).
       # @author Sylvain Daubert
       class LSARouter < LSAHeader
@@ -103,10 +113,13 @@ module PacketGen
         #  16-bit flag word
         #  @return [Integer]
         # @attribute v_flag
+        #  Virtual link point flag
         #  @return [Integer]
-        # @attribute e_flag
+        # @attribute e_flag*
+        #  AS boundary flag
         #  @return [Integer]
         # @attribute b_flag
+        #  Area border router flag
         #  @return [Integer]
         define_bit_attr :u16, z: 5, v_flag: 1, e_flag: 1, b_flag: 1, zz: 8
         # @attribute link_count
@@ -114,6 +127,7 @@ module PacketGen
         #  @return [Integer]
         define_attr :link_count, BinStruct::Int16
         # @attribute links
+        #  Router links
         #  @return [ArrayOfLink]
         define_attr :links, ArrayOfLink, builder: ->(h, t) { t.new(counter: h[:link_count]) }
       end
@@ -138,33 +152,42 @@ module PacketGen
 
       # This class handles external links in {LSAASExternal LSA AS-External payloads}.
       # @author Sylvain Daubert
+      # @author LemonTree55
       class External < BinStruct::Struct
         include BinStruct::Structable
 
         # @!attribute u8
+        #  1st byte containing {#e_flag} and #{tos}
         #  @return [Integer]
         # @!attribute e_flag
+        #  1-bit type of external metric.
+        #  If set, {#metric} is Type 2 external metric, else it is Type1.
         #  @return [Integer]
         # @!attribute tos
+        #  7-bit TOS
         #  @return [Integer]
         define_bit_attr :u8, e_flag: 1, tos: 7
         # @!attribute metric
+        #  Cost of this route
         #  @return [Integer]
         define_attr :metric, BinStruct::Int24
         # @!attribute forwarding_addr
+        #  Forwarding address
         #  @return [IP::Addr]
         define_attr :forwarding_addr, IP::Addr
         # @!attribute ext_route_tag
+        #  32-bit external route tag. Not used by OSPF protocol.
         #  @return [Integer]
         define_attr :ext_route_tag, BinStruct::Int32
 
+        # Get human-readable string
         # @return [String]
         def to_human
           "<type:#{e_flag? ? 2 : 1},tos:#{tos},metric:#{metric},fwaddr:#{forwarding_addr},tag:#{ext_route_tag}>"
         end
       end
 
-      # This class defines a specialized {BinStruct::Array array} to handle series
+      # This class defines a specialized +BinStruct::Array+ to handle series
       # of {External Externals}.
       # @author Sylvain Daubert
       class ArrayOfExternal < BinStruct::Array
@@ -189,18 +212,18 @@ module PacketGen
                     builder: ->(h, t) { t.new(length_from: -> { h.length - 24 }) }
       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}. It recognizes known LSA types and infers correct type.
       # @author Sylvain Daubert
       class ArrayOfLSA < BinStruct::Array
         set_of LSAHeader
 
         # @param [Hash] options
-        # @option options [BinStruct::Int] counter Int object used as a counter for this set
-        # @option options [Boolean] only_headers if +true+, only {LSAHeader LSAHeaders}
+        # @option options [BinStruct::Int] :counter +BinStruct::Int+ object used as a counter for this set
+        # @option options [Boolean] :only_headers if +true+, only {LSAHeader LSAHeaders}
         #  will be added to this array.
         def initialize(options={})
-          super()
+          super
           @only_headers = options[:only_headers] || false
         end
 

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

@@ -75,7 +75,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
@@ -93,7 +93,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)
@@ -105,6 +105,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/ospfv2.rb

@@ -9,7 +9,7 @@
 module PacketGen
   module Header
     # This class supports OSPFv2 (RFC 2328).
-    # A OSPFv2 header has the following format:
+    # An OSPFv2 header has the following format:
     #
     #    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
@@ -28,37 +28,38 @@ module PacketGen
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # An OSPFv2 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 {#au_type} field ({BinStruct::Int16Enum}),
-    # * an {#authentication} field ({BinStruct::Int64}),
-    # * 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 {#au_type} field (+BinStruct::Int16Enum+),
+    # * an {#authentication} field (+BinStruct::Int64+),
+    # * and a {#body} (+BinStruct::String+ or {Headerable}).
     #
-    # == Create an OSPFv2 header
+    # @example Create an OSPFv2 header
     #   # standalone
     #   ospf = PacketGen::Header::OSPFv2.new
     #   # in a packet
-    #   pkt = PacketGen.gen('IP', src: source_ip).add('OSPFv2')
+    #   pkt = PacketGen.gen('IP').add('OSPFv2')
     #   # make IP 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.ospfv2    # => PacketGen::Header::OSPFv2
+    #   pkt.ospfv2.class    # => PacketGen::Header::OSPFv2
     #
-    # == OSPFv2 attributes
-    #  ospf.version              # => 2
-    #  ospf.type = 'LS_ACK'      # or 5
-    #  ospf.length = 154
-    #  ospf.router_id = 0xc0a80001
-    #  ospf.area_id = 1
-    #  ospf.checksum = 0xabcd
-    #  ospf.au_type = 'NO_AUTH'  # or 0
-    #  ospf.authentication = 0
+    # @example OSPFv2 attributes
+    #   ospf = PacketGen::Header::OSPFv2.new
+    #   ospf.version              # => 2
+    #   ospf.type = 'LS_ACK'      # or 5
+    #   ospf.length = 154
+    #   ospf.router_id = 0xc0a80001
+    #   ospf.area_id = 1
+    #   ospf.checksum = 0xabcd
+    #   ospf.au_type = 'NO_AUTH'  # or 0
+    #   ospf.authentication = 0
     #
     # == OSPFv2 body
     # OSPFv2 {#body} should contain OSPF payload for given {#type}:
@@ -124,7 +125,8 @@ module PacketGen
       #  @return [Integer]
       define_attr :authentication, BinStruct::Int64
       # @!attribute body
-      #  @return [String,Base]
+      #  OSPF body
+      #  @return [String,Headerable]
       define_attr :body, BinStruct::String
 
       # @api private
@@ -164,12 +166,15 @@ module PacketGen
       # @api private
       # @note This method is used internally by PacketGen and should not be
       #       directly called
+      # @param [Packet] packet
+      # @return [void]
+      # 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
         # #authentication field is not used in checksum calculation,
@@ -198,7 +203,7 @@ module PacketGen
         self[:au_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)
@@ -213,7 +218,7 @@ module PacketGen
       #    pkt.ospfv2.ospfize
       #    # second way
       #    pkt.ospfize
-      # @param [String,Symbol,nil] dst destination address. May be a dotted IP
+      # @param [String,Symbolnil] dst destination address. May be a dotted IP
       #   address (by example '224.0.0.5') or a Symbol (+:all_spf_routers+ or
       #   +:all_d_routers+)
       # @return [void]

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

@@ -33,25 +33,26 @@ module PacketGen
       #   |                              ...                               |
       #
       # A DB description payload is composed of:
-      # * a 8-bit {#reserved} field ({BinStruct::Int8}),
-      # * a 24-bit {#options} field ({BinStruct::Int24}),
-      # * a 16-bit {#mtu} field ({BinStruct::Int16}),
-      # * a 16-bit {#flags} field ({BinStruct::Int16}). Supported flags are:
+      # * a 8-bit {#reserved} field (+BinStruct::Int8+),
+      # * a 24-bit {#options} field (+BinStruct::Int24+),
+      # * a 16-bit {#mtu} field (+BinStruct::Int16+),
+      # * a 16-bit {#flags} field (+BinStruct::Int16+). Supported flags are:
       #   * {i_flag},
       #   * {m_flag},
       #   * {ms_flag},
-      # * a 32-bit {#sequence_number} field ({BinStruct::Int32}),
+      # * a 32-bit {#sequence_number} field (+BinStruct::Int32+),
       # * and an array of {LSAHeader LSAHeaders} ({#lsas}, {ArrayOfLSA}).
       #
-      # == Create a DbDescription payload
+      # @example Create a DbDescription payload
       #   # standalone
       #   dbd = PacketGen::Header::OSPFv3::DbDescription.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3').add('OSPFv3::DbDescription')
+      #   pkt = PacketGen.gen('IPv6').add('OSPFv3').add('OSPFv3::DbDescription')
       #   # access to DbDescription payload
-      #   pkt.ospfv3_dbdescription    # => PacketGen::Header::OSPFv3::DbDescription
+      #   pkt.ospfv3_dbdescription.class    # => PacketGen::Header::OSPFv3::DbDescription
       #
-      # == DbDescription attributes
+      # @example DbDescription attributes
+      #   dbd = PacketGen::Header::OSPFv3::DbDescription.new
       #   dbd.reserved = 0
       #   # set options. Options may also be set one by one with #v6_opt, #e_opt,
       #   # #n_opt, #r_opt and #dc_opt
@@ -61,8 +62,6 @@ module PacketGen
       #   dbd.seqnum = 0x800001
       #   # add a LSA Router header
       #   dbd.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
-      #   dbd.lsas << existing_lsa.to_lsa_header
       # @author Sylvain Daubert
       class DbDescription < Base
         # @!attribute reserved
@@ -70,7 +69,7 @@ module PacketGen
         #  @return [Integer]
         define_attr :reserved, BinStruct::Int8, default: 0
 
-        # @!macro define_options
+        # @!macro define_ospfv3_options
         OSPFv3.define_options(self)
 
         # @!attribute mtu
@@ -101,7 +100,7 @@ module PacketGen
 
         # @!attribute lsas
         #  Array of LSA headers
-        #  @return [ArrayOfLSAHeader]
+        #  @return [ArrayOfLSA]
         define_attr :lsas, ArrayOfLSA, builder: ->(_h, t) { t.new(only_headers: true) }
       end
     end

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

@@ -28,26 +28,27 @@ module PacketGen
       #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       #   |                        ...                                    |
       # A HELLO payload consists of:
-      # * a {#interface_id} field ({BinStruct::Int32}),
-      # * a {#priority} field ({BinStruct::Int8}),
-      # * an {#options} field ({BinStruct::Int24}),
-      # * a {#hello_interval} field ({BinStruct::Int16}),
-      # * a {#dead_interval} field ({BinStruct::Int16}),
+      # * a {#interface_id} field (+BinStruct::Int32+),
+      # * a {#priority} field (+BinStruct::Int8+),
+      # * an {#options} field (+BinStruct::Int24+),
+      # * a {#hello_interval} field (+BinStruct::Int16+),
+      # * a {#dead_interval} field (+BinStruct::Int16+),
       # * a {#designated_router} field ({IP::Addr}),
       # * a {#backup_designated_router} field ({IP::Addr}),
       # * a {#neighbors} array containing neighbors as {IP::Addr}.
       #
-      # == Create a HELLO payload
+      # @example Create a HELLO payload
       #   # standalone
       #   hello = PacketGen::Header::OSPFv3::Hello.new
       #   # in a packet
-      #   pkt = PacketGen.gen('IPv6', src: source_ip).add('OSPFv3').add('OSPFv3::Hello')
+      #   pkt = PacketGen.gen('IPv6').add('OSPFv3').add('OSPFv3::Hello')
       #   # make IPv6 header correct for OSPF
       #   pkt.ospfize
       #   # access to Hello payload
-      #   pkt.ospfv3_hello    # => PacketGen::Header::OSPFv3::Hello
+      #   pkt.ospfv3_hello.class    # => PacketGen::Header::OSPFv3::Hello
       #
-      # == HELLO attributes
+      # @example HELLO attributes
+      #   hello = PacketGen::Header::OSPFv3::Hello.new
       #   hello.interface_id = 1
       #   hello.priority = 1
       #   # set options. Options may also be set one by one with #v6_opt, #e_opt,