nl-linux 0.3.0 → 0.4.1

data/generated/nl/linux/drm_ras.rb

@@ -3,97 +3,199 @@
 # This file is based on Documentation/netlink/specs/drm_ras.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
-# rbs_inline: enabled
 # This code is generated by Ynl::Generator. DO NOT EDIT.
 require 'nl'
 module Nl; module Linux
 # DRM RAS (Reliability, Availability, Serviceability) over Generic Netlink. Provides a standardized mechanism for DRM drivers to register "nodes" representing hardware/software components capable of reporting error counters. Userspace tools can query the list of nodes or individual error counters via the Generic Netlink interface.
-class DrmRas < ::Nl::Family
+class DrmRas < ::Nl::Genl::Family
   NAME = "drm-ras"
-  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("drm-ras"))
+  VERSION = 1
+  # @rbs (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+  # @rbs | [R] (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) { (instance) -> R } -> R
+  # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+  #   @param [#call] resolver
+  #   @param [Symbol, nil] executor
+  #   @param [Integer, nil] notification_capacity
+  #   @return [DrmRas]
+  # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY, &block)
+  #   @param [#call] resolver
+  #   @param [Symbol, nil] executor
+  #   @param [Integer, nil] notification_capacity
+  #   @yieldparam [DrmRas] family
+  #   @return [Object] the result of the block
+  def self.open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+    super
+  end
+  # @private
   MCAST_GROUPS = Ractor.make_shareable({}) #: Hash[::Symbol, ::Nl::McastGroup]
+  module Enums
+    # Type of the node. Currently, only error-counter nodes are supported, which expose reliability counters for a hardware/software component.
+    module NodeType
+      ErrorCounter = 1
+    end
+  end
   module Structs
   end
   module AttributeSets
-    class NodeAttrs < ::Nl::Protocols::Genl::AttributeSet
+    class NodeAttrs < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
+      # Unique identifier for the node. Assigned dynamically by the DRM RAS core upon registration.
       class NodeId < Attribute
         TYPE = 1
         NAME = :"node_id"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # Device name chosen by the driver at registration. Can be a PCI BDF, UUID, or module name if unique.
       class DeviceName < Attribute
         TYPE = 2
         NAME = :"device_name"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::String.new(check: nil)
       end
+      # Node name chosen by the driver at registration. Can be an IP block name, or any name that identifies the RAS node inside the device.
       class NodeName < Attribute
         TYPE = 3
         NAME = :"node_name"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::String.new(check: nil)
       end
+      # Type of this node, identifying its function.
+      # 
+      # Known enum values are defined in {Enums::NodeType}.
       class NodeType < Attribute
         TYPE = 4
         NAME = :"node_type"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"node_id" => NodeId, :"device_name" => DeviceName, :"node_name" => NodeName, :"node_type" => NodeType}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => NodeId, 2 => DeviceName, 3 => NodeName, 4 => NodeType}) #: Hash[::Integer, Attribute]
+      # Unique identifier for the node. Assigned dynamically by the DRM RAS core upon registration.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see NodeId
+      def node_id; self[:"node_id"]&.value; end
+      # Device name chosen by the driver at registration. Can be a PCI BDF, UUID, or module name if unique.
+      # @rbs return: ::String
+      # @return [String]
+      # @see DeviceName
+      def device_name; self[:"device_name"]&.value; end
+      # Node name chosen by the driver at registration. Can be an IP block name, or any name that identifies the RAS node inside the device.
+      # @rbs return: ::String
+      # @return [String]
+      # @see NodeName
+      def node_name; self[:"node_name"]&.value; end
+      # Type of this node, identifying its function.
+      # 
+      # Known enum values are defined in {Enums::NodeType}.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see NodeType
+      def node_type; self[:"node_type"]&.value; end
       class << self
         # Looks up Attribute class by name.
-        #--
         # @rbs name: Symbol
         # @rbs return: Attribute
+        # @param [Symbol] name
+        # @return [Attribute]
         def by_name(name); BY_NAME.fetch(name); end
         # Looks up Attribute class by type value.
-        #--
         # @rbs type: Integer
         # @rbs return: Attribute
+        # @param [Integer] type
+        # @return [Attribute]
         def by_type(type); BY_TYPE.fetch(type); end
       end
     end
-    class ErrorCounterAttrs < ::Nl::Protocols::Genl::AttributeSet
+    class ErrorCounterAttrs < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
+      # Node ID targeted by this error counter operation.
       class NodeId < Attribute
         TYPE = 1
         NAME = :"node_id"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # Unique identifier for a specific error counter within an node.
       class ErrorId < Attribute
         TYPE = 2
         NAME = :"error_id"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # Name of the error.
       class ErrorName < Attribute
         TYPE = 3
         NAME = :"error_name"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::String.new(check: nil)
       end
+      # Current value of the requested error counter.
       class ErrorValue < Attribute
         TYPE = 4
         NAME = :"error_value"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"node_id" => NodeId, :"error_id" => ErrorId, :"error_name" => ErrorName, :"error_value" => ErrorValue}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => NodeId, 2 => ErrorId, 3 => ErrorName, 4 => ErrorValue}) #: Hash[::Integer, Attribute]
+      # Node ID targeted by this error counter operation.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see NodeId
+      def node_id; self[:"node_id"]&.value; end
+      # Unique identifier for a specific error counter within an node.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see ErrorId
+      def error_id; self[:"error_id"]&.value; end
+      # Name of the error.
+      # @rbs return: ::String
+      # @return [String]
+      # @see ErrorName
+      def error_name; self[:"error_name"]&.value; end
+      # Current value of the requested error counter.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see ErrorValue
+      def error_value; self[:"error_value"]&.value; end
       class << self
         # Looks up Attribute class by name.
-        #--
         # @rbs name: Symbol
         # @rbs return: Attribute
+        # @param [Symbol] name
+        # @return [Attribute]
         def by_name(name); BY_NAME.fetch(name); end
         # Looks up Attribute class by type value.
-        #--
         # @rbs type: Integer
         # @rbs return: Attribute
+        # @param [Integer] type
+        # @return [Attribute]
         def by_type(type); BY_TYPE.fetch(type); end
       end
     end
@@ -102,7 +204,7 @@ class DrmRas < ::Nl::Family
     # Retrieve the full list of currently registered DRM RAS nodes. Each node includes its dynamically assigned ID, name, and type. **Important:** User space must call this operation first to obtain the node IDs. These IDs are required for all subsequent operations on nodes, such as querying error counters.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DumpListNodesRequest < ::Nl::Protocols::Genl::Message
+    class DumpListNodesRequest < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::NodeAttrs
@@ -111,196 +213,256 @@ class DrmRas < ::Nl::Family
     # Retrieve the full list of currently registered DRM RAS nodes. Each node includes its dynamically assigned ID, name, and type. **Important:** User space must call this operation first to obtain the node IDs. These IDs are required for all subsequent operations on nodes, such as querying error counters.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DumpListNodesReply < ::Nl::Protocols::Genl::Message
+    class DumpListNodesReply < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::NodeAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[node_id device_name node_name node_type])
-      # Gets the value of `node-id` attribute in the message.
-      #--
+      # Unique identifier for the node. Assigned dynamically by the DRM RAS core upon registration.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::NodeAttrs::NodeId
       def node_id; attributes[:"node_id"]&.value; end
-      # Gets the value of `device-name` attribute in the message.
-      #--
+      # Device name chosen by the driver at registration. Can be a PCI BDF, UUID, or module name if unique.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::NodeAttrs::DeviceName
       def device_name; attributes[:"device_name"]&.value; end
-      # Gets the value of `node-name` attribute in the message.
-      #--
+      # Node name chosen by the driver at registration. Can be an IP block name, or any name that identifies the RAS node inside the device.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::NodeAttrs::NodeName
       def node_name; attributes[:"node_name"]&.value; end
-      # Gets the value of `node-type` attribute in the message.
-      #--
+      # Type of this node, identifying its function.
+      # 
+      # Known enum values are defined in {Enums::NodeType}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::NodeAttrs::NodeType
       def node_type; attributes[:"node_type"]&.value; end
     end
     # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DoGetErrorCounterRequest < ::Nl::Protocols::Genl::Message
+    class DoGetErrorCounterRequest < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::ErrorCounterAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[node_id error_id])
-      # Gets the value of `node-id` attribute in the message.
-      #--
+      # Node ID targeted by this error counter operation.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::ErrorCounterAttrs::NodeId
       def node_id; attributes[:"node_id"]&.value; end
-      # Gets the value of `error-id` attribute in the message.
-      #--
+      # Unique identifier for a specific error counter within an node.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::ErrorCounterAttrs::ErrorId
       def error_id; attributes[:"error_id"]&.value; end
     end
     # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DoGetErrorCounterReply < ::Nl::Protocols::Genl::Message
+    class DoGetErrorCounterReply < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::ErrorCounterAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[error_id error_name error_value])
-      # Gets the value of `error-id` attribute in the message.
-      #--
+      # Unique identifier for a specific error counter within an node.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::ErrorCounterAttrs::ErrorId
       def error_id; attributes[:"error_id"]&.value; end
-      # Gets the value of `error-name` attribute in the message.
-      #--
+      # Name of the error.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::ErrorCounterAttrs::ErrorName
       def error_name; attributes[:"error_name"]&.value; end
-      # Gets the value of `error-value` attribute in the message.
-      #--
+      # Current value of the requested error counter.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::ErrorCounterAttrs::ErrorValue
       def error_value; attributes[:"error_value"]&.value; end
     end
     # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DumpGetErrorCounterRequest < ::Nl::Protocols::Genl::Message
+    class DumpGetErrorCounterRequest < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::ErrorCounterAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[node_id])
-      # Gets the value of `node-id` attribute in the message.
-      #--
+      # Node ID targeted by this error counter operation.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::ErrorCounterAttrs::NodeId
       def node_id; attributes[:"node_id"]&.value; end
     end
     # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DumpGetErrorCounterReply < ::Nl::Protocols::Genl::Message
+    class DumpGetErrorCounterReply < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::ErrorCounterAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[error_id error_name error_value])
-      # Gets the value of `error-id` attribute in the message.
-      #--
+      # Unique identifier for a specific error counter within an node.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::ErrorCounterAttrs::ErrorId
       def error_id; attributes[:"error_id"]&.value; end
-      # Gets the value of `error-name` attribute in the message.
-      #--
+      # Name of the error.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::ErrorCounterAttrs::ErrorName
       def error_name; attributes[:"error_name"]&.value; end
-      # Gets the value of `error-value` attribute in the message.
-      #--
+      # Current value of the requested error counter.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::ErrorCounterAttrs::ErrorValue
       def error_value; attributes[:"error_value"]&.value; end
     end
     # Clear error counter for a given node. The request includes the error-id and node-id of the counter to be cleared.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    class DoClearErrorCounterRequest < ::Nl::Protocols::Genl::Message
+    class DoClearErrorCounterRequest < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::ErrorCounterAttrs
       ATTRIBUTES = Ractor.make_shareable(%i[node_id error_id])
-      # Gets the value of `node-id` attribute in the message.
-      #--
+      # Node ID targeted by this error counter operation.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::ErrorCounterAttrs::NodeId
       def node_id; attributes[:"node_id"]&.value; end
-      # Gets the value of `error-id` attribute in the message.
-      #--
+      # Unique identifier for a specific error counter within an node.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::ErrorCounterAttrs::ErrorId
       def error_id; attributes[:"error_id"]&.value; end
     end
   end
   module Notifications
   end
+  # @private
   NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
   # Retrieve the full list of currently registered DRM RAS nodes. Each node includes its dynamically assigned ID, name, and type. **Important:** User space must call this operation first to obtain the node IDs. These IDs are required for all subsequent operations on nodes, such as querying error counters.
   # 
   # Requires CAP_NET_ADMIN in the initial user namespace.
-  #--
-  # @rbs () -> Enumerable[Messages::DumpListNodesReply]
+  # @rbs () -> Array[Messages::DumpListNodesReply]
   #   | () { (Messages::DumpListNodesReply) -> void } -> void
+  # @overload dump_list_nodes(**args)
+  #   Returns an array when no block is given.
+  #   @param [Hash] args
+  #   @return [Array<Messages::DumpListNodesReply>]
+  # @overload dump_list_nodes(**args, &block)
+  #   Yields each reply when a block is given.
+  #   @param [Hash] args
+  #   @yieldparam [Messages::DumpListNodesReply] reply
+  #   @return [void]
+  # @see Messages::DumpListNodesRequest
   def dump_list_nodes(**args, &block)
     exchange_message(:"dump", Messages::DumpListNodesRequest, Messages::DumpListNodesReply, args, &block)
   end
   # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
   # 
   # Requires CAP_NET_ADMIN in the initial user namespace.
-  #--
   # @rbs (?node_id: ::Integer, ?error_id: ::Integer) -> Messages::DoGetErrorCounterReply
+  # @param [Hash] args
+  # @option args [Integer] node_id Node ID targeted by this error counter operation.
+  # @option args [Integer] error_id Unique identifier for a specific error counter within an node.
+  # @return [Messages::DoGetErrorCounterReply]
+  # @see Messages::DoGetErrorCounterRequest
   def do_get_error_counter(**args)
     exchange_message(:"do", Messages::DoGetErrorCounterRequest, Messages::DoGetErrorCounterReply, args)
   end
   # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
   # 
   # Requires CAP_NET_ADMIN in the initial user namespace.
-  #--
-  # @rbs (?node_id: ::Integer) -> Enumerable[Messages::DumpGetErrorCounterReply]
+  # @rbs (?node_id: ::Integer) -> Array[Messages::DumpGetErrorCounterReply]
   #   | (?node_id: ::Integer) { (Messages::DumpGetErrorCounterReply) -> void } -> void
+  # @overload dump_get_error_counter(**args)
+  #   Returns an array when no block is given.
+  #   @param [Hash] args
+  #   @option args [Integer] node_id Node ID targeted by this error counter operation.
+  #   @return [Array<Messages::DumpGetErrorCounterReply>]
+  # @overload dump_get_error_counter(**args, &block)
+  #   Yields each reply when a block is given.
+  #   @param [Hash] args
+  #   @option args [Integer] node_id Node ID targeted by this error counter operation.
+  #   @yieldparam [Messages::DumpGetErrorCounterReply] reply
+  #   @return [void]
+  # @see Messages::DumpGetErrorCounterRequest
   def dump_get_error_counter(**args, &block)
     exchange_message(:"dump", Messages::DumpGetErrorCounterRequest, Messages::DumpGetErrorCounterReply, args, &block)
   end
   # Clear error counter for a given node. The request includes the error-id and node-id of the counter to be cleared.
   # 
   # Requires CAP_NET_ADMIN in the initial user namespace.
-  #--
   # @rbs (?node_id: ::Integer, ?error_id: ::Integer) -> void
+  # @param [Hash] args
+  # @option args [Integer] node_id Node ID targeted by this error counter operation.
+  # @option args [Integer] error_id Unique identifier for a specific error counter within an node.
+  # @return [void]
+  # @see Messages::DoClearErrorCounterRequest
   def do_clear_error_counter(**args)
     exchange_message(:"do", Messages::DoClearErrorCounterRequest, nil, args)
   end
   class AsyncOperations
-    # :nodoc:
+    # @private
     def initialize(&exchange)
       @exchange = exchange
     end
     # Retrieve the full list of currently registered DRM RAS nodes. Each node includes its dynamically assigned ID, name, and type. **Important:** User space must call this operation first to obtain the node IDs. These IDs are required for all subsequent operations on nodes, such as querying error counters.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    #--
     # @rbs () -> ::Nl::Async::Stream[Messages::DumpListNodesReply]
+    # @param [Hash] args
+    # @return [Nl::Async::Stream<Messages::DumpListNodesReply>]
+    # @see Messages::DumpListNodesRequest
     def dump_list_nodes(**args)
       @exchange.call(:"dump", Messages::DumpListNodesRequest, Messages::DumpListNodesReply, args)
     end
     # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    #--
     # @rbs (?node_id: ::Integer, ?error_id: ::Integer) -> ::Nl::Async::Future[Messages::DoGetErrorCounterReply]
+    # @param [Hash] args
+    # @option args [Integer] node_id Node ID targeted by this error counter operation.
+    # @option args [Integer] error_id Unique identifier for a specific error counter within an node.
+    # @return [Nl::Async::Future<Messages::DoGetErrorCounterReply>]
+    # @see Messages::DoGetErrorCounterRequest
     def do_get_error_counter(**args)
       @exchange.call(:"do", Messages::DoGetErrorCounterRequest, Messages::DoGetErrorCounterReply, args)
     end
     # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    #--
     # @rbs (?node_id: ::Integer) -> ::Nl::Async::Stream[Messages::DumpGetErrorCounterReply]
+    # @param [Hash] args
+    # @option args [Integer] node_id Node ID targeted by this error counter operation.
+    # @return [Nl::Async::Stream<Messages::DumpGetErrorCounterReply>]
+    # @see Messages::DumpGetErrorCounterRequest
     def dump_get_error_counter(**args)
       @exchange.call(:"dump", Messages::DumpGetErrorCounterRequest, Messages::DumpGetErrorCounterReply, args)
     end
     # Clear error counter for a given node. The request includes the error-id and node-id of the counter to be cleared.
     # 
     # Requires CAP_NET_ADMIN in the initial user namespace.
-    #--
     # @rbs (?node_id: ::Integer, ?error_id: ::Integer) -> ::Nl::Async::Future[void]
+    # @param [Hash] args
+    # @option args [Integer] node_id Node ID targeted by this error counter operation.
+    # @option args [Integer] error_id Unique identifier for a specific error counter within an node.
+    # @return [Nl::Async::Future<void>]
+    # @see Messages::DoClearErrorCounterRequest
     def do_clear_error_counter(**args)
       @exchange.call(:"do", Messages::DoClearErrorCounterRequest, nil, args)
     end
   end
   # Returns the asynchronous operation facade for this family.
-  #--
   # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+  # @param [::Integer, nil] stream_capacity
+  # @return [AsyncOperations]
   def async(stream_capacity: nil)
     return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
     build_async_facade(AsyncOperations, stream_capacity:)