nl-linux 0.3.0 → 0.4.1

data/generated/nl/linux/dev_energymodel.rb

@@ -8,334 +8,519 @@
 #
 #--
 # frozen_string_literal: true
-# rbs_inline: enabled
 # This code is generated by Ynl::Generator. DO NOT EDIT.
 require 'nl'
 module Nl; module Linux
 # Energy model netlink interface to notify its changes.
-class DevEnergymodel < ::Nl::Family
+class DevEnergymodel < ::Nl::Genl::Family
   NAME = "dev-energymodel"
-  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("dev-energymodel"))
+  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 [DevEnergymodel]
+  # @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 [DevEnergymodel] 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({:"event" => ::Nl::McastGroup.new("event", nil)}) #: Hash[::Symbol, ::Nl::McastGroup]
+  module Flags
+    module PerfStateFlags
+      # The performance state is inefficient. There is in this perf-domain, another performance state with a higher frequency but a lower or equal power cost.
+      PerfStateInefficient = 1
+    end
+    module PerfDomainFlags
+      # The power values are in micro-Watts or some other scale.
+      PerfDomainMicrowatts = 1
+      # Skip inefficient states when estimating energy consumption.
+      PerfDomainSkipInefficiencies = 2
+      # The power values are artificial and might be created by platform missing real power information.
+      PerfDomainArtificial = 4
+    end
+  end
   module Structs
   end
   module AttributeSets
     # Information on a single performance domains.
-    class PerfDomain < ::Nl::Protocols::Genl::AttributeSet
+    class PerfDomain < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
       class Pad < Attribute
         TYPE = 1
         NAME = :"pad"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Pad.new()
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Pad.new()
       end
+      # A unique ID number for each performance domain.
       class PerfDomainId < Attribute
         TYPE = 2
         NAME = :"perf_domain_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
+      # Bitmask of performance domain flags.
+      # 
+      # Known flags are defined in {Flags::PerfDomainFlags}.
       class Flags < Attribute
         TYPE = 3
         NAME = :"flags"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
       end
+      # CPUs that belong to this performance domain.
       class Cpus < Attribute
         TYPE = 4
         NAME = :"cpus"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+        # @private
+        MULTI = true
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"pad" => Pad, :"perf_domain_id" => PerfDomainId, :"flags" => Flags, :"cpus" => Cpus}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Pad, 2 => PerfDomainId, 3 => Flags, 4 => Cpus}) #: Hash[::Integer, Attribute]
+      # A unique ID number for each performance domain.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see PerfDomainId
+      def perf_domain_id; self[:"perf_domain_id"]&.value; end
+      # Bitmask of performance domain flags.
+      # 
+      # Known flags are defined in {Flags::PerfDomainFlags}.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Flags
+      def flags; self[:"flags"]&.value; end
+      # CPUs that belong to this performance domain.
+      # @rbs return: ::Array[::Integer]
+      # @return [Array<Integer>]
+      # @see Cpus
+      def cpus; self[:"cpus"].map(&: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
     # Performance states table.
-    class PerfTable < ::Nl::Protocols::Genl::AttributeSet
+    class PerfTable < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
+      # A unique ID number for each performance domain.
       class PerfDomainId < Attribute
         TYPE = 1
         NAME = :"perf_domain_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
       class PerfState < Attribute
         TYPE = 2
         NAME = :"perf_state"
+        # @private
+        MULTI = true
+        # @private
+        ORDER = 1
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"perf_domain_id" => PerfDomainId, :"perf_state" => PerfState}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => PerfDomainId, 2 => PerfState}) #: Hash[::Integer, Attribute]
+      # A unique ID number for each performance domain.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see PerfDomainId
+      def perf_domain_id; self[:"perf_domain_id"]&.value; end
+      # @rbs return: ::Array[AttributeSets::PerfState]
+      # @return [Array<AttributeSets::PerfState>]
+      # @see PerfState
+      def perf_state; self[:"perf_state"].map(&: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
     # Performance state of a performance domain.
-    class PerfState < ::Nl::Protocols::Genl::AttributeSet
+    class PerfState < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
       class Pad < Attribute
         TYPE = 1
         NAME = :"pad"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Pad.new()
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Pad.new()
       end
+      # CPU performance (capacity) at a given frequency.
       class Performance < Attribute
         TYPE = 2
         NAME = :"performance"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
       end
+      # The frequency in KHz, for consistency with CPUFreq.
       class Frequency < Attribute
         TYPE = 3
         NAME = :"frequency"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
       end
+      # The power consumed at this level (by 1 CPU or by a registered device). It can be a total power: static and dynamic.
       class Power < Attribute
         TYPE = 4
         NAME = :"power"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
       end
+      # The cost coefficient associated with this level, used during energy calculation. Equal to: power * max_frequency / frequency.
       class Cost < Attribute
         TYPE = 5
         NAME = :"cost"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+        # @private
+        ORDER = 4
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
       end
+      # Bitmask of performance state flags.
+      # 
+      # Known flags are defined in {Flags::PerfStateFlags}.
       class Flags < Attribute
         TYPE = 6
         NAME = :"flags"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+        # @private
+        ORDER = 5
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"pad" => Pad, :"performance" => Performance, :"frequency" => Frequency, :"power" => Power, :"cost" => Cost, :"flags" => Flags}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Pad, 2 => Performance, 3 => Frequency, 4 => Power, 5 => Cost, 6 => Flags}) #: Hash[::Integer, Attribute]
+      # CPU performance (capacity) at a given frequency.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Performance
+      def performance; self[:"performance"]&.value; end
+      # The frequency in KHz, for consistency with CPUFreq.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Frequency
+      def frequency; self[:"frequency"]&.value; end
+      # The power consumed at this level (by 1 CPU or by a registered device). It can be a total power: static and dynamic.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Power
+      def power; self[:"power"]&.value; end
+      # The cost coefficient associated with this level, used during energy calculation. Equal to: power * max_frequency / frequency.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Cost
+      def cost; self[:"cost"]&.value; end
+      # Bitmask of performance state flags.
+      # 
+      # Known flags are defined in {Flags::PerfStateFlags}.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Flags
+      def flags; self[:"flags"]&.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
-    PerfTable::PerfState::DATATYPE = ::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(PerfState)
+    # @private
+    PerfTable::PerfState::DATATYPE = ::Nl::DataTypes::NestedAttributes.new(AttributeSets::PerfState, selector_bindings: Ractor.make_shareable([]))
   end
   module Messages
     # Get the list of information for all performance domains.
-    class DoGetPerfDomainsRequest < ::Nl::Protocols::Genl::Message
+    class DoGetPerfDomainsRequest < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::PerfDomain
       ATTRIBUTES = Ractor.make_shareable(%i[perf_domain_id])
-      # Gets the value of `perf-domain-id` attribute in the message.
-      #--
+      # A unique ID number for each performance domain.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::PerfDomain::PerfDomainId
       def perf_domain_id; attributes[:"perf_domain_id"]&.value; end
     end
     # Get the list of information for all performance domains.
-    class DoGetPerfDomainsReply < ::Nl::Protocols::Genl::Message
+    class DoGetPerfDomainsReply < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::PerfDomain
       ATTRIBUTES = Ractor.make_shareable(%i[pad perf_domain_id flags cpus])
-      # Gets the value of `perf-domain-id` attribute in the message.
-      #--
+      # A unique ID number for each performance domain.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::PerfDomain::PerfDomainId
       def perf_domain_id; attributes[:"perf_domain_id"]&.value; end
-      # Gets the value of `flags` attribute in the message.
-      #--
+      # Bitmask of performance domain flags.
+      # 
+      # Known flags are defined in {Flags::PerfDomainFlags}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::PerfDomain::Flags
       def flags; attributes[:"flags"]&.value; end
-      # Gets the value of `cpus` attribute in the message.
-      #--
-      # @rbs return: ::Integer
-      def cpus; attributes[:"cpus"]&.value; end
+      # CPUs that belong to this performance domain.
+      # @rbs return: ::Array[::Integer]
+      # @return [Array<Integer>]
+      # @see AttributeSets::PerfDomain::Cpus
+      def cpus; attributes[:"cpus"].map(&:value); end
     end
     # Get the list of information for all performance domains.
-    class DumpGetPerfDomainsRequest < ::Nl::Protocols::Genl::Message
+    class DumpGetPerfDomainsRequest < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::PerfDomain
       ATTRIBUTES = Ractor.make_shareable(%i[])
     end
     # Get the list of information for all performance domains.
-    class DumpGetPerfDomainsReply < ::Nl::Protocols::Genl::Message
+    class DumpGetPerfDomainsReply < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::PerfDomain
       ATTRIBUTES = Ractor.make_shareable(%i[pad perf_domain_id flags cpus])
-      # Gets the value of `perf-domain-id` attribute in the message.
-      #--
+      # A unique ID number for each performance domain.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::PerfDomain::PerfDomainId
       def perf_domain_id; attributes[:"perf_domain_id"]&.value; end
-      # Gets the value of `flags` attribute in the message.
-      #--
+      # Bitmask of performance domain flags.
+      # 
+      # Known flags are defined in {Flags::PerfDomainFlags}.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::PerfDomain::Flags
       def flags; attributes[:"flags"]&.value; end
-      # Gets the value of `cpus` attribute in the message.
-      #--
-      # @rbs return: ::Integer
-      def cpus; attributes[:"cpus"]&.value; end
+      # CPUs that belong to this performance domain.
+      # @rbs return: ::Array[::Integer]
+      # @return [Array<Integer>]
+      # @see AttributeSets::PerfDomain::Cpus
+      def cpus; attributes[:"cpus"].map(&:value); end
     end
     # Get the energy model table of a performance domain.
-    class DoGetPerfTableRequest < ::Nl::Protocols::Genl::Message
+    class DoGetPerfTableRequest < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::PerfTable
       ATTRIBUTES = Ractor.make_shareable(%i[perf_domain_id])
-      # Gets the value of `perf-domain-id` attribute in the message.
-      #--
+      # A unique ID number for each performance domain.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::PerfTable::PerfDomainId
       def perf_domain_id; attributes[:"perf_domain_id"]&.value; end
     end
     # Get the energy model table of a performance domain.
-    class DoGetPerfTableReply < ::Nl::Protocols::Genl::Message
+    class DoGetPerfTableReply < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::PerfTable
       ATTRIBUTES = Ractor.make_shareable(%i[perf_domain_id perf_state])
-      # Gets the value of `perf-domain-id` attribute in the message.
-      #--
+      # A unique ID number for each performance domain.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::PerfTable::PerfDomainId
       def perf_domain_id; attributes[:"perf_domain_id"]&.value; end
-      # Gets the value of `perf-state` attribute in the message.
-      #--
-      # @rbs return: AttributeSets::PerfState
-      def perf_state; attributes[:"perf_state"]&.value; end
+      # @rbs return: ::Array[AttributeSets::PerfState]
+      # @return [Array<AttributeSets::PerfState>]
+      # @see AttributeSets::PerfTable::PerfState
+      def perf_state; attributes[:"perf_state"].map(&:value); end
     end
   end
   module Notifications
     # A performance domain is created.
     # 
     # Multicast group: `event`.
-    class PerfDomainCreated < ::Nl::Protocols::Genl::Message
+    class PerfDomainCreated < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::PerfTable
       ATTRIBUTES = Ractor.make_shareable(%i[perf_domain_id perf_state])
-      # Gets the value of `perf-domain-id` attribute in the message.
-      #--
+      # A unique ID number for each performance domain.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::PerfTable::PerfDomainId
       def perf_domain_id; attributes[:"perf_domain_id"]&.value; end
-      # Gets the value of `perf-state` attribute in the message.
-      #--
-      # @rbs return: AttributeSets::PerfState
-      def perf_state; attributes[:"perf_state"]&.value; end
+      # @rbs return: ::Array[AttributeSets::PerfState]
+      # @return [Array<AttributeSets::PerfState>]
+      # @see AttributeSets::PerfTable::PerfState
+      def perf_state; attributes[:"perf_state"].map(&:value); end
     end
     # A performance domain is updated.
     # 
     # Multicast group: `event`.
-    class PerfDomainUpdated < ::Nl::Protocols::Genl::Message
+    class PerfDomainUpdated < ::Nl::Genl::Message
       TYPE = 4
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::PerfTable
       ATTRIBUTES = Ractor.make_shareable(%i[perf_domain_id perf_state])
-      # Gets the value of `perf-domain-id` attribute in the message.
-      #--
+      # A unique ID number for each performance domain.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::PerfTable::PerfDomainId
       def perf_domain_id; attributes[:"perf_domain_id"]&.value; end
-      # Gets the value of `perf-state` attribute in the message.
-      #--
-      # @rbs return: AttributeSets::PerfState
-      def perf_state; attributes[:"perf_state"]&.value; end
+      # @rbs return: ::Array[AttributeSets::PerfState]
+      # @return [Array<AttributeSets::PerfState>]
+      # @see AttributeSets::PerfTable::PerfState
+      def perf_state; attributes[:"perf_state"].map(&:value); end
     end
     # A performance domain is deleted.
     # 
     # Multicast group: `event`.
-    class PerfDomainDeleted < ::Nl::Protocols::Genl::Message
+    class PerfDomainDeleted < ::Nl::Genl::Message
       TYPE = 5
       FIXED_HEADER = nil
       ATTRIBUTE_SET = AttributeSets::PerfTable
       ATTRIBUTES = Ractor.make_shareable(%i[perf_domain_id])
-      # Gets the value of `perf-domain-id` attribute in the message.
-      #--
+      # A unique ID number for each performance domain.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::PerfTable::PerfDomainId
       def perf_domain_id; attributes[:"perf_domain_id"]&.value; end
     end
   end
+  # @private
   NOTIFICATIONS = Ractor.make_shareable({3 => Notifications::PerfDomainCreated, 4 => Notifications::PerfDomainUpdated, 5 => Notifications::PerfDomainDeleted}) #: Hash[::Integer, ::Class]
   # Get the list of information for all performance domains.
-  #--
   # @rbs (?perf_domain_id: ::Integer) -> Messages::DoGetPerfDomainsReply
+  # @param [Hash] args
+  # @option args [Integer] perf_domain_id A unique ID number for each performance domain.
+  # @return [Messages::DoGetPerfDomainsReply]
+  # @see Messages::DoGetPerfDomainsRequest
   def do_get_perf_domains(**args)
     exchange_message(:"do", Messages::DoGetPerfDomainsRequest, Messages::DoGetPerfDomainsReply, args)
   end
   # Get the list of information for all performance domains.
-  #--
-  # @rbs () -> Enumerable[Messages::DumpGetPerfDomainsReply]
+  # @rbs () -> Array[Messages::DumpGetPerfDomainsReply]
   #   | () { (Messages::DumpGetPerfDomainsReply) -> void } -> void
+  # @overload dump_get_perf_domains(**args)
+  #   Returns an array when no block is given.
+  #   @param [Hash] args
+  #   @return [Array<Messages::DumpGetPerfDomainsReply>]
+  # @overload dump_get_perf_domains(**args, &block)
+  #   Yields each reply when a block is given.
+  #   @param [Hash] args
+  #   @yieldparam [Messages::DumpGetPerfDomainsReply] reply
+  #   @return [void]
+  # @see Messages::DumpGetPerfDomainsRequest
   def dump_get_perf_domains(**args, &block)
     exchange_message(:"dump", Messages::DumpGetPerfDomainsRequest, Messages::DumpGetPerfDomainsReply, args, &block)
   end
   # Get the energy model table of a performance domain.
-  #--
   # @rbs (?perf_domain_id: ::Integer) -> Messages::DoGetPerfTableReply
+  # @param [Hash] args
+  # @option args [Integer] perf_domain_id A unique ID number for each performance domain.
+  # @return [Messages::DoGetPerfTableReply]
+  # @see Messages::DoGetPerfTableRequest
   def do_get_perf_table(**args)
     exchange_message(:"do", Messages::DoGetPerfTableRequest, Messages::DoGetPerfTableReply, args)
   end
   class AsyncOperations
-    # :nodoc:
+    # @private
     def initialize(&exchange)
       @exchange = exchange
     end
     # Get the list of information for all performance domains.
-    #--
     # @rbs (?perf_domain_id: ::Integer) -> ::Nl::Async::Future[Messages::DoGetPerfDomainsReply]
+    # @param [Hash] args
+    # @option args [Integer] perf_domain_id A unique ID number for each performance domain.
+    # @return [Nl::Async::Future<Messages::DoGetPerfDomainsReply>]
+    # @see Messages::DoGetPerfDomainsRequest
     def do_get_perf_domains(**args)
       @exchange.call(:"do", Messages::DoGetPerfDomainsRequest, Messages::DoGetPerfDomainsReply, args)
     end
     # Get the list of information for all performance domains.
-    #--
     # @rbs () -> ::Nl::Async::Stream[Messages::DumpGetPerfDomainsReply]
+    # @param [Hash] args
+    # @return [Nl::Async::Stream<Messages::DumpGetPerfDomainsReply>]
+    # @see Messages::DumpGetPerfDomainsRequest
     def dump_get_perf_domains(**args)
       @exchange.call(:"dump", Messages::DumpGetPerfDomainsRequest, Messages::DumpGetPerfDomainsReply, args)
     end
     # Get the energy model table of a performance domain.
-    #--
     # @rbs (?perf_domain_id: ::Integer) -> ::Nl::Async::Future[Messages::DoGetPerfTableReply]
+    # @param [Hash] args
+    # @option args [Integer] perf_domain_id A unique ID number for each performance domain.
+    # @return [Nl::Async::Future<Messages::DoGetPerfTableReply>]
+    # @see Messages::DoGetPerfTableRequest
     def do_get_perf_table(**args)
       @exchange.call(:"do", Messages::DoGetPerfTableRequest, Messages::DoGetPerfTableReply, 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:)
   end
-  #--
   # @rbs (*(:event) groups) -> self
+  # @param [Array<:event>] groups
+  # @return [self]
   def subscribe(*groups) = super
-  #--
   # @rbs (*(:event) groups) -> self
+  # @param [Array<:event>] groups
+  # @return [self]
   def unsubscribe(*groups) = super
 end
 end; end