packetgen 4.0.0 → 4.1.1

data/lib/packetgen/header/dhcpv6/options.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -11,8 +11,8 @@ module PacketGen
     class DHCPv6
       # Container class for DHCPv6 {Option options}.
       #
-      # == Add DHCPv6 options to an +Options+ instance
-      #   options = PacketGen::Header::DHCP::Options.new
+      # @example Add DHCPv6 options to an +Options+ instance
+      #   options = PacketGen::Header::DHCPv6::Options.new
       #   # Add an ElapsedTime option
       #   options << { type: 'ElapsedTime', value: 3600 }
       #   # Add a ClientID. Here, use integer type
@@ -22,7 +22,7 @@ module PacketGen
       class Options < BinStruct::Array
         set_of DHCPv6::Option
 
-        # Separator used in {#to_human}.
+        # Separator used in +#to_human+.
         HUMAN_SEPARATOR = ';'
 
         private

data/lib/packetgen/header/dhcpv6/relay.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -38,6 +38,7 @@ module PacketGen
         #   @return [IPv6::Addr]
         define_attr :peer, IPv6::Addr
         # @!attribute options
+        #   Set of {Option}s
         #   @return [DHCPv6::Options]
         define_attr :options, DHCPv6::Options
       end

data/lib/packetgen/header/dhcpv6.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -22,22 +22,20 @@ module PacketGen
     #   |                                                               |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A DHCPv6 header is made of:
-    # * a {#msg_type} field ({BinStruct::Int8Enum}),
-    # * a {#transaction_id} field ({BinStruct::Int24}),
-    # * and an {#options} field ({DHCPv6::Options}).
+    # * a {#msg_type} field (+BinStruct::Int8Enum+),
+    # * a {#transaction_id} field (+BinStruct::Int24+),
+    # * and an {#options} field ({DHCPv6::Options}). This field is a container for {DHCPv6::Option} objects.
     #
-    # == Create a DHCPv6 header
+    # @example Create a DHCPv6 header
     #   # standalone
-    #  dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
-    #  # in a packet
-    #  pkt = PacketGen.gen('IPv6').add('DHCPv6', msg_type: 'SOLLICIT')
-    #  # access to DHCPv6 header from packet
-    #  pkt.dhcpv6    #=> PacketGen::Header::DHCPv6
-    #
-    # == Add options
-    # DHCPv6 options are defined by subclasses of {DHCPv6::Option}.
+    #   dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
+    #   # in a packet
+    #   pkt = PacketGen.gen('IPv6').add('UDP').add('DHCPv6', msg_type: 'SOLLICIT')
+    #   # access to DHCPv6 header from packet
+    #   pkt.dhcpv6.class    #=> PacketGen::Header::DHCPv6
     #
-    # Options may be added by pushing a hash to {#options}:
+    # @example Add options
+    #   # Options may be added by pushing a hash to #options:
     #   dhcpv6 = PacketGen::Header::DHCPv6.new(msg_type: 'SOLLICIT')
     #   dhcpv6.options << { type: 'Preference', value: 1 }
     # @author Sylvain Daubert
@@ -75,9 +73,10 @@ module PacketGen
       define_attr :msg_type, BinStruct::Int8Enum, enum: MESSAGE_TYPES
       # @!attribute transaction_id
       #   24-bit transaction ID
-      # @return [Integer]
+      #   @return [Integer]
       define_attr :transaction_id, BinStruct::Int24
       # @!attribute options
+      #   Set of {Option}s
       #   @return [DHCPv6::Options]
       define_attr :options, DHCPv6::Options
 

data/lib/packetgen/header/dns/name.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -9,13 +9,14 @@
 module PacketGen
   module Header
     class DNS
-      # DNS Name, defined as a suite of labels. A label is of type {BinStruct::IntString}.
+      # DNS Name, defined as a suite of labels. A label is of type +BinStruct::IntString+.
       # @author Sylvain Daubert
       # @author LemonTree55
       class Name < BinStruct::Array
         # Mask to decode a pointer on another label
         POINTER_MASK = 0xc000
 
+        # DNS message to which this name is attached. Used to decode compressed names
         # @return [DNS]
         attr_accessor :dns
 
@@ -49,32 +50,32 @@ module PacketGen
         end
 
         # Clear name
-        #   @return [void]
+        # @return [void]
         def clear
           super
           @pointer = nil
           @pointer_name = nil
         end
 
-        # Read a sequence of label from a string
+        # Read a sequence of label from a binary string
         # @param [String] str binary string
         # @return [Name] self
         def read(str)
           clear
           return self if str.nil?
 
-          PacketGen.force_binary(str)
+          strb = str.to_s.b
           start = 0
           loop do
-            index = str[start, 2].unpack1('n')
+            index = strb[start, 2].unpack1('n')
             if pointer?(index)
               # Pointer on another label
-              @pointer = str[start, 2]
+              @pointer = strb[start, 2]
               break
             else
-              label = add_label_from(str[start..])
+              label = add_label_from(strb[start..])
               start += label.sz
-              break if label.empty? || str[start..].empty?
+              break if label.empty? || strb[start..].empty?
             end
           end
           # force resolution of compressed names

data/lib/packetgen/header/dns/opt.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -15,6 +15,7 @@ module PacketGen
       #
       # a OPT record may contain zero or more {Option options} in its {#rdata}.
       # @author Sylvain Daubert
+      # @author LemonTree55
       # @since 1.3.0
       # @since 3.1.1 {#options} is a {ArrayOfOptions}
       class OPT < RR
@@ -118,11 +119,13 @@ module PacketGen
         alias udp_size rrclass
         alias udp_size= rrclass=
 
+        # Get human-readable string for flags
         # @return [String]
         def human_flags
           do? ? 'do' : 'none'
         end
 
+        # Get human-readable string for this OPT
         # @return [String]
         def to_human
           "#{name} #{human_type} UDPsize:#{udp_size} " \

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -11,18 +11,18 @@ module PacketGen
     class DNS
       # @!parse
       #  # DNS option is a TLV object:
-      #  # * {#code} is a {BinStruct::Int16},
-      #  # * {#length} is a {BinStruct::Int16},
-      #  # * {#data} is a {BinStruct::String}.
+      #  # * {#code} is a BinStruct::Int16,
+      #  # * +#length+ is a BinStruct::Int16,
+      #  # * {#data} is a BinStruct::String.
       #  #
       #  # @since 1.3.0
-      #  # @since 3.1.0 defined with {BinStruct::AbstractTLV}
+      #  # @since 3.1.0 defined with BinStruct::AbstractTLV
       #  # @!parse class Option < BinStruct::AbstractTLV; end
       #  # @!attribute code
-      #  #   Alias for {#type}
+      #  #   Alias for +#type+
       #  #   @return [Integer]
       #  # @!attribute data
-      #  #   Alias for {#value}
+      #  #   Alias for +#value+
       #  #   @return [BinStruct::String]
       #  class Option < BinStruct::AbstractTLV; end
       # @private
@@ -30,7 +30,7 @@ module PacketGen
                                              length_class: BinStruct::Int16,
                                              aliases: { code: :type, data: :value })
 
-      # Array of {Option}.
+      # Array of {Option}s.
       # @since 3.1.1
       class ArrayOfOptions < BinStruct::Array
         set_of Option

data/lib/packetgen/header/dns/qdsection.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -25,14 +25,14 @@ module PacketGen
         #  @param [Question] q
         #  @return [Question]
 
-        # Read Question section from a string
+        # Read Question section from a binary string
         # @param [String] str binary string
         # @return [QDSection] self
         def read(str)
           clear
           return self if str.nil?
 
-          PacketGen.force_binary str
+          str = str.b unless str.encoding == Encoding::ASCII_8BIT
           while !str.empty? && (self.size < @counter.to_i)
             question = Question.new(@dns).read(str)
             str.slice!(0, question.sz)

data/lib/packetgen/header/dns/question.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -120,6 +120,7 @@ module PacketGen
           end
         end
 
+        # Human-readable string for this question
         # @return [String]
         def to_human
           if self[:name].dns.is_a? MDNS

data/lib/packetgen/header/dns/rr.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -87,9 +87,7 @@ module PacketGen
           self[:rdata].read(data)
         end
 
-        # rubocop:disable Metrics/AbcSize
-
-        # Get human readable rdata
+                # Get human readable rdata
         # @return [String]
         def human_rdata
           str = human_ip_rdata || self[:rdata].inspect

data/lib/packetgen/header/dns/rrsection.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -21,13 +21,13 @@ module PacketGen
         end
 
         # Read RR section from a string
-        # @param [String] str binary string
+        # @param [String] str binary binary string
         # @return [RRSection] self
         def read(str)
           clear
           return self if str.nil?
 
-          PacketGen.force_binary str
+          str = str.b unless str.encoding == Encoding::BINARY
           while !str.empty? && (self.size < @counter.to_i)
             rr = RR.new(@dns).read(str)
             rr = OPT.new(@dns).read(str) if rr.type?('OPT')

data/lib/packetgen/header/dns.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -33,70 +33,77 @@ module PacketGen
     # * {#ns}, authoritary section,
     # * {#ar}, additional information section.
     #
-    # == Create a DNS header
-    #  # standalone
-    #  dns = PacketGen::Header::DNS.new
-    #  # in a IP packet
-    #  pkt = PacketGen.gen('IP').add('DNS')
-    #  # access to DNS header
-    #  pkt.dns   # => PacketGen::Header::DNS
+    # @example Create a DNS header
+    #   # standalone
+    #   dns = PacketGen::Header::DNS.new
+    #   # in a IP packet
+    #   pkt = PacketGen.gen('IP').add('UDP').add('DNS')
+    #   # access to DNS header
+    #   pkt.dns.class   # => PacketGen::Header::DNS
     #
-    # == DNS attributes
-    #  dns.id = 0x1234
-    #  dns.qr = false
-    #  # opcode may be set as an Integer (all values are possible)
-    #  # or as a String (only keys from PacketGen::Header::DNS::OPCODES)
-    #  dns.opcode = 0xe       # set as integer, value not defined in standard
-    #  dns.opcode = 'query'   # set as string
-    #  dns.aa = dns.tc = dns.rd = dns.ra = false
-    #  # rcode may be set as an Integer (all values are possible)
-    #  # or as a String (only keys from PacketGen::Header::DNS::RCODES)
-    #  dns.rcode = 11
-    #  dns.rcode = 'refused'
-    #  dns.qdcount = 123
-    #  dns.ancount = 0x1234
-    #  dns.nscount = 1
-    #  dns.arcount = 0
-    # One can also access to DNS sections:
-    #  dns.qd   # => PacketGen::Header::DNS::QDSection
-    #  dns.an   # => PacketGen::Header::DNS::RRSection
-    #  dns.ns   # => PacketGen::Header::DNS::RRSection
-    #  dns.ar   # => PacketGen::Header::DNS::RRSection
+    # @example DNS attributes
+    #   dns = PacketGen::Header::DNS.new
+    #   dns.id = 0x1234
+    #   dns.qr = false
+    #   # opcode may be set as an Integer (all values are possible)
+    #   # or as a String (only keys from PacketGen::Header::DNS::OPCODES)
+    #   dns.opcode = 0xe       # set as integer, value not defined in standard
+    #   dns.opcode = 'query'   # set as string
+    #   # Set flags
+    #   dns.aa = dns.tc = dns.rd = dns.ra = false
+    #   # rcode may be set as an Integer (all values are possible)
+    #   # or as a String (only keys from PacketGen::Header::DNS::RCODES)
+    #   dns.rcode = 11
+    #   dns.rcode = 'refused'
+    #   # Section counts may be set by hand. They also be set automatically when adding
+    #   # an element to a section.
+    #   dns.qdcount = 123
+    #   dns.ancount = 0x1234
+    #   dns.nscount = 1
+    #   dns.arcount = 0
+    #   # Access to DNS sections:
+    #   dns.qd.class   # => PacketGen::Header::DNS::QDSection
+    #   dns.an.class   # => PacketGen::Header::DNS::RRSection
+    #   dns.ns.class   # => PacketGen::Header::DNS::RRSection
+    #   dns.ar.class   # => PacketGen::Header::DNS::RRSection
     #
-    # == Add a question to DNS question section
-    # Adding a {Question} with {QDSection#<<} automagically increments {#qdcount}.
-    # To not modify +qdcount+, use {QDSection#push}.
-    #  # add a question about example.net IP address. Increment qdcount
-    #  dns.qd << PacketGen::Header::DNS::Question.new(dns, name: 'example.net')
-    #  # or
-    #  dns.qd << { rtype: 'Question', name: 'example.net' }
-    #  # add a question about example.net IPv6 address. Dot not modify qdcount
-    #  dns.qd.push PacketGen::Header::DNS::Question.new(dns, name: 'example.net', type: 'AAAA')
-    #  # or
-    #  dns.qd.push({ rtype: 'Question', name: 'example.net', type: 'AAAA' })
+    # @example Add a question to DNS question section
+    #   dns = PacketGen::Header::DNS.new
+    #   # add a question about example.net IP address. Increment qdcount
+    #   dns.qd << PacketGen::Header::DNS::Question.new(dns, name: 'example.net')
+    #   # or
+    #   dns.qd << { rtype: 'Question', name: 'example.net' }
+    #   dns.qdcount    #=> 2
+    #   # add a question about example.net IPv6 address. Dot not modify qdcount
+    #   dns.qd.push(PacketGen::Header::DNS::Question.new(dns, name: 'example.net', type: 'AAAA'))
+    #   # or
+    #   dns.qd.push(rtype: 'Question', name: 'example.net', type: 'AAAA')
+    #   dns.qdcount    #=> 2
     #
-    # == Add a ressource record to a DNS section
-    # Adding a {RR} with {RRSection#<< RRSection#<<} automagically increments section counter.
-    # To not modify it, use {RRSection#push RRSection#push}
-    #  # add a RR to answer section. Increment ancount
-    #  dns.an << PacketGen::Header::DNS::RR.new(dns, name: 'example.net', rdata: IPAddr.new('1.2.3.4').hton)
-    #  # or
-    #  dns.an << { rtype: 'RR', name: 'example.net', rdata: IPAddr.new('1.2.3.4').hton }
-    #  # add a RR to NS section. Dot not modify nscount
-    #  rdata = PacketGen::Header::DNS::Name.new(dns).parse('dns.net')
-    #  dns.ns.push PacketGen::Header::DNS::RR.new(dns, name: 'example.net', type: 'NS', rdata: rdata)
-    #  # or
-    #  dns.ns.push(rtype: 'RR', name: 'example.net', type: 'NS', rdata: rdata)
+    # @example Add a ressource record to a DNS section
+    #   dns = PacketGen::Header::DNS.new
+    #   # add a RR to answer section. Increment ancount
+    #   dns.an << PacketGen::Header::DNS::RR.new(dns, name: 'example.net', rdata: IPAddr.new('1.2.3.4').hton)
+    #   # or
+    #   dns.an << { rtype: 'RR', name: 'example.net', rdata: IPAddr.new('1.2.3.4').hton }
+    #   dns.ancount   #=> 2
+    #   # add a RR to NS section. Dot not modify nscount
+    #   rdata = PacketGen::Header::DNS::Name.new(dns: dns).from_human('dns.net')
+    #   dns.ns.push(PacketGen::Header::DNS::RR.new(dns, name: 'example.net', type: 'NS', rdata: rdata))
+    #   # or
+    #   dns.ns.push(rtype: 'RR', name: 'example.net', type: 'NS', rdata: rdata)
+    #   dns.nscount   #=> 0
     #
-    # == Extended DNS EDNS(0)
-    #  # Add an OPT to ar section
-    #  dns.ar << PacketGen::Header::DNS::OPT.new(dns, udp_size: 4096, ext_rcode: 43)
-    #  # or
-    #  dns.ar << { rtype: 'OPT', udp_size: 4096, ext_rcode: 43 }
-    #  # add an option to OPT record
-    #  dns.ar.last.options << PacketGen::Header::DNS::Option.new(code: 48, data: '12')
-    #  # or
-    #  dns.ar.last.options << { code: 48, data: '12' }
+    # @example Extended DNS (EDNS(0)) options
+    #   dns = PacketGen::Header::DNS.new
+    #   # Add an OPT to ar section
+    #   dns.ar << PacketGen::Header::DNS::OPT.new(dns, udp_size: 4096, ext_rcode: 43)
+    #   # or
+    #   dns.ar << { rtype: 'OPT', udp_size: 4096, ext_rcode: 43 }
+    #   # add an option to OPT record
+    #   dns.ar.last.options << PacketGen::Header::DNS::Option.new(code: 48, data: '12')
+    #   # or
+    #   dns.ar.last.options << { code: 48, data: '12' }
     # @author Sylvain Daubert
     # @since 1.3.0
     class DNS < Base
@@ -140,6 +147,7 @@ module PacketGen
       }.freeze
 
       # @!attribute id
+      #  16-bit identifier to match up replies and queries
       #  @return [Integer]
       define_attr :id, BinStruct::Int16
       # @!attribute u16
@@ -166,27 +174,35 @@ module PacketGen
       undef opcode=, rcode=
 
       # @!attribute qdcount
+      #  Number of entries in {#qd question section}
       #  @return [Integer]
       define_attr :qdcount, BinStruct::Int16
       # @!attribute ancount
+      #  Number of ressource recors in {#an answer section}
       #  @return [Integer]
       define_attr :ancount, BinStruct::Int16
       # @!attribute nscount
+      #  Number of name resource recors in {#ns authority records section}
       #  @return [Integer]
       define_attr :nscount, BinStruct::Int16
       # @!attribute arcount
+      #  Number of ressources recors in {#ar additional records section}
       #  @return [Integer]
       define_attr :arcount, BinStruct::Int16
       # @!attribute qd
+      #  Question section
       #  @return [QDSection]
       define_attr :qd, QDSection, builder: ->(h, t) { t.new(h, h[:qdcount]) }
       # @!attribute an
+      #  Answer section
       #  @return [RRSection]
       define_attr :an, RRSection, builder: ->(h, t) { t.new(h, h[:ancount]) }
       # @!attribute ns
+      #  Authority records section
       #  @return [RRSection]
       define_attr :ns, RRSection, builder: ->(h, t) { t.new(h, h[:nscount]) }
       # @!attribute ar
+      #  Additional record section
       #  @return [RRSection]
       define_attr :ar, RRSection, builder: ->(h, t) { t.new(h, h[:arcount]) }
 

data/lib/packetgen/header/dot11/control.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -12,16 +12,16 @@ module PacketGen
     class Dot11
       # IEEE 802.11 control frame header
       #
-      # This class make a {Dot11} header with {#type} set to +1+
+      # This class makes a {Dot11} header with {#type} set to +1+
       # (control frame).
       #
       # A IEEE 802.11 control header consists of:
-      # * a {#frame_ctrl} ({BinStruct::Int16}),
-      # * a {#id}/duration ({BinStruct::Int16le}),
+      # * a {#frame_ctrl} (+BinStruct::Int16+),
+      # * a {#id}/duration (+BinStruct::Int16le+),
       # * a {#mac1} ({Eth::MacAddr}).
       # * sometimes a {#mac2} ({Eth::MacAddr}),
-      # * a {#body} (a {BinStruct::String} or another {Base} class),
-      # * and a Frame check sequence ({#fcs}, of type {BinStruct::Int32le}).
+      # * a {#body} (a +BinStruct::String+ or another {Headerable} class),
+      # * and a Frame check sequence ({#fcs}, of type +BinStruct::Int32le+).
       # @author Sylvain Daubert
       class Control < Dot11
         # Control subtypes

data/lib/packetgen/header/dot11/data.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -16,15 +16,16 @@ module PacketGen
       # (data frame).
       #
       # A IEEE 802.11 data header consists of:
-      # * a {#frame_ctrl} ({BinStruct::Int16}),
-      # * a {#id}/duration ({BinStruct::Int16le}),
+      # * a {#frame_ctrl} (+BinStruct::Int16+),
+      # * a {#id}/duration (+BinStruct::Int16le+),
+      # * a {#mac1} ({Eth::MacAddr}),
       # * a {#mac2} ({Eth::MacAddr}),
       # * a {#mac3} ({Eth::MacAddr}),
-      # * a {#sequence_ctrl} ({BinStruct::Int16}),
+      # * a {#sequence_ctrl} (+BinStruct::Int16+),
       # * sometimes a {#mac4} ({Eth::MacAddr}),
-      # * sometimes a {#qos_ctrl} ({BinStruct::Int16}),
-      # * a {#body} (a {BinStruct::String} or another {Base} class),
-      # * and a Frame check sequence ({#fcs}, of type {BinStruct::Int32le}).
+      # * sometimes a {#qos_ctrl} (+BinStruct::Int16+),
+      # * a {#body} (a +BinStruct::String+ or another {Headerable} class),
+      # * and a Frame check sequence ({#fcs}, of type +BinStruct::Int32le+).
       # @author Sylvain Daubert
       class Data < Dot11
         # @param [Hash] options
@@ -65,14 +66,14 @@ module PacketGen
           self
         end
 
-        # Get destination MAC address
+        # Get destination MAC address. {#from_ds} and {#to_ds} must be set before using these method.
         # @return [String]
         def dst
           _src_mac, dst_mac = src_dst_from_mac
           self.send(dst_mac)
         end
 
-        # Set destination MAC address
+        # Set destination MAC address. {#from_ds} and {#to_ds} must be set before using these method.
         # @param [String] mac MAC address to set
         # @return [String]
         def dst=(mac)
@@ -80,14 +81,14 @@ module PacketGen
           self.send(:"#{dst_mac}=", mac)
         end
 
-        # Get source MAC address
+        # Get source MAC address. {#from_ds} and {#to_ds} must be set before using these method.
         # @return [String]
         def src
           src_mac, = src_dst_from_mac
           self.send(src_mac)
         end
 
-        # Set source MAC address
+        # Set source MAC address. {#from_ds} and {#to_ds} must be set before using these method.
         # @param [String] mac MAC address to set
         # @return [String]
         def src=(mac)

data/lib/packetgen/header/dot11/element.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 # This file is part of PacketGen
-# See https://github.com/lemontree55/packetgen for more informations
+# See https://codeberg.org/lemontree55/packetgen for more informations
 # Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
@@ -15,7 +15,7 @@ module PacketGen
       #  #
       #  # An {Element} is a piece of data contained in a Dot11 management frame.
       #  # @since 1.4.0
-      #  # @since 3.1.0 subclass of {BinStruct::AbstractTLV}
+      #  # @since 3.1.0 subclass of +BinStruct::AbstractTLV+
       #  class Element < BinStruct::AbstractTLV; end
       # @private
       Element = BinStruct::AbstractTLV.create