From 85dce0061c222384ea1213c49801446e87c0e299 Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Tue, 29 Aug 2023 14:07:52 +0100 Subject: [PATCH] reword docstrings --- lib/voicemeeter/base.rb | 2 +- lib/voicemeeter/bus.rb | 2 +- lib/voicemeeter/button.rb | 2 +- lib/voicemeeter/patch.rb | 2 +- lib/voicemeeter/recorder.rb | 2 +- lib/voicemeeter/remote.rb | 4 ++-- lib/voicemeeter/strip.rb | 2 +- lib/voicemeeter/vban.rb | 4 ++-- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/voicemeeter/base.rb b/lib/voicemeeter/base.rb index 4dc3c9d..f30fd81 100644 --- a/lib/voicemeeter/base.rb +++ b/lib/voicemeeter/base.rb @@ -1,5 +1,5 @@ module Voicemeeter - # Base class for Remote types + # Base class for Remote class Base include Logging include Worker diff --git a/lib/voicemeeter/bus.rb b/lib/voicemeeter/bus.rb index 4dbd92d..54725a1 100644 --- a/lib/voicemeeter/bus.rb +++ b/lib/voicemeeter/bus.rb @@ -1,6 +1,6 @@ module Voicemeeter module Bus - # Base class for Bus types + # Base class for Bus class Base include IRemote include Mixins::Fades diff --git a/lib/voicemeeter/button.rb b/lib/voicemeeter/button.rb index a3a0292..85c2ae6 100644 --- a/lib/voicemeeter/button.rb +++ b/lib/voicemeeter/button.rb @@ -26,7 +26,7 @@ module Voicemeeter end end - # Base class for Button types + # Base class for Button class Base include Logging include IRemote diff --git a/lib/voicemeeter/patch.rb b/lib/voicemeeter/patch.rb index d810ba1..693dc32 100644 --- a/lib/voicemeeter/patch.rb +++ b/lib/voicemeeter/patch.rb @@ -1,6 +1,6 @@ module Voicemeeter module Patch - # Base class for Patch types + # Base class for Patch class Base include IRemote attr_reader :asio, :A2, :A3, :A4, :A5, :composite, :insert diff --git a/lib/voicemeeter/recorder.rb b/lib/voicemeeter/recorder.rb index 5b7eb05..05b571d 100644 --- a/lib/voicemeeter/recorder.rb +++ b/lib/voicemeeter/recorder.rb @@ -7,7 +7,7 @@ module Voicemeeter MP3 = 100 end - # Base class for Recorder types + # Base class for Recorder class Base include IRemote include Mixins::Outputs diff --git a/lib/voicemeeter/remote.rb b/lib/voicemeeter/remote.rb index bbca250..323a3bd 100644 --- a/lib/voicemeeter/remote.rb +++ b/lib/voicemeeter/remote.rb @@ -26,7 +26,7 @@ module Voicemeeter module Remote extend Logging - # Concrete class for Remote types + # Concrete class for Remote class Remote < Base include Builder @@ -75,7 +75,7 @@ module Voicemeeter end end - # Factory class for Remote types. Returns a Remote class of a kind. + # Factory class for Remote. Returns a Remote class of a kind. class RequestRemote def self.for(kind, **) case kind.name diff --git a/lib/voicemeeter/strip.rb b/lib/voicemeeter/strip.rb index 3a9a04b..e067f2d 100644 --- a/lib/voicemeeter/strip.rb +++ b/lib/voicemeeter/strip.rb @@ -1,6 +1,6 @@ module Voicemeeter module Strip - # Base class for Strip types + # Base class for Strip class Base include IRemote include Mixins::Outputs diff --git a/lib/voicemeeter/vban.rb b/lib/voicemeeter/vban.rb index 2b817ed..280dd9c 100644 --- a/lib/voicemeeter/vban.rb +++ b/lib/voicemeeter/vban.rb @@ -1,6 +1,6 @@ module Voicemeeter module Vban - # Base class for Vban Stream types + # Base class for Vban In/Out Streams class VbanStream include IRemote @@ -81,7 +81,7 @@ module Voicemeeter end end - # Base class for Vban type + # Base class for Vban class Base attr_reader :instream, :outstream