From 918f3298510be4505306813bd71699b61ec8dfc5 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 14 Dec 2015 10:32:25 +0000 Subject: nodoc internal classes DTAS does not expose any sort of public API for external users, so it will not be documented using RDoc. Currently all of our documentation is in plain-text or Markdown (only for manpages). --- lib/dtas/cue_index.rb | 2 +- lib/dtas/mlib.rb | 2 +- lib/dtas/nonblock.rb | 2 +- lib/dtas/parse_freq.rb | 2 +- lib/dtas/parse_time.rb | 2 +- lib/dtas/partstats.rb | 4 ++-- lib/dtas/tfx.rb | 4 ++-- lib/dtas/track.rb | 2 +- lib/dtas/watchable.rb | 13 +++++++------ 9 files changed, 17 insertions(+), 16 deletions(-) (limited to 'lib/dtas') diff --git a/lib/dtas/cue_index.rb b/lib/dtas/cue_index.rb index b23dae3..9fca5c2 100644 --- a/lib/dtas/cue_index.rb +++ b/lib/dtas/cue_index.rb @@ -3,7 +3,7 @@ require_relative '../dtas' # embedded CUE sheet representation for -player -class DTAS::CueIndex +class DTAS::CueIndex # :nodoc: attr_reader :offset attr_reader :index diff --git a/lib/dtas/mlib.rb b/lib/dtas/mlib.rb index 51ee70e..b81ec54 100644 --- a/lib/dtas/mlib.rb +++ b/lib/dtas/mlib.rb @@ -7,7 +7,7 @@ require_relative 'process' require 'socket' # For the DTAS Music Library, based on what MPD uses. -class DTAS::Mlib +class DTAS::Mlib # :nodoc: attr_accessor :follow_outside_symlinks attr_accessor :follow_inside_symlinks attr_accessor :tags diff --git a/lib/dtas/nonblock.rb b/lib/dtas/nonblock.rb index c8beecd..1a4b8b0 100644 --- a/lib/dtas/nonblock.rb +++ b/lib/dtas/nonblock.rb @@ -1,7 +1,7 @@ # Copyright (C) 2015 all contributors # License: GPL-3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt) -class DTAS::Nonblock < IO +class DTAS::Nonblock < IO # :nodoc: if RUBY_VERSION.to_f <= 2.0 EX = {}.freeze def read_nonblock(len, buf = nil, opts = EX) diff --git a/lib/dtas/parse_freq.rb b/lib/dtas/parse_freq.rb index 2fd418e..db1b33f 100644 --- a/lib/dtas/parse_freq.rb +++ b/lib/dtas/parse_freq.rb @@ -2,7 +2,7 @@ # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt) require_relative '../dtas' -module DTAS::ParseFreq +module DTAS::ParseFreq # :nodoc: # may return a negative frequency meaning lowpass def parse_freq(val, round = true) diff --git a/lib/dtas/parse_time.rb b/lib/dtas/parse_time.rb index 454c067..5c22baf 100644 --- a/lib/dtas/parse_time.rb +++ b/lib/dtas/parse_time.rb @@ -3,7 +3,7 @@ # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt) require_relative '../dtas' -module DTAS::ParseTime +module DTAS::ParseTime # :nodoc: # convert a string time to seconds, returning a Floot or Integer def parse_time(time) case time diff --git a/lib/dtas/partstats.rb b/lib/dtas/partstats.rb index bc13480..7019b3d 100644 --- a/lib/dtas/partstats.rb +++ b/lib/dtas/partstats.rb @@ -8,14 +8,14 @@ require_relative 'sigevent' # backend for the dtas-partstats(1) command # Unlike the stuff for dtas-player, dtas-partstats is fairly tied to sox -class DTAS::PartStats +class DTAS::PartStats # :nodoc: CMD = 'sox "$INFILE" -n $TRIMFX $SOXFX stats $STATSOPTS' include DTAS::Process include DTAS::SpawnFix attr_reader :key_idx attr_reader :key_width - class TrimPart < Struct.new(:tbeg, :tlen, :rate) + class TrimPart < Struct.new(:tbeg, :tlen, :rate) # :nodoc: def sec tbeg / rate end diff --git a/lib/dtas/tfx.rb b/lib/dtas/tfx.rb index 479ff5c..ff03819 100644 --- a/lib/dtas/tfx.rb +++ b/lib/dtas/tfx.rb @@ -7,7 +7,7 @@ require 'shellwords' # this will represent a trim section inside -splitfx for applying # effects to only a part of the output -class DTAS::TFX +class DTAS::TFX # :nodoc: include DTAS::ParseTime attr_reader :tbeg @@ -85,7 +85,7 @@ class DTAS::TFX end # for stable sorting - class TFXSort < Struct.new(:tfx, :idx) + class TFXSort < Struct.new(:tfx, :idx) # :nodoc: def <=>(other) cmp = tfx <=> other.tfx 0 == cmp ? idx <=> other.idx : cmp diff --git a/lib/dtas/track.rb b/lib/dtas/track.rb index 215ee52..b69f63f 100644 --- a/lib/dtas/track.rb +++ b/lib/dtas/track.rb @@ -2,7 +2,7 @@ # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt) require_relative '../dtas' -class DTAS::Track +class DTAS::Track # :nodoc: attr_reader :track_id attr_reader :to_path diff --git a/lib/dtas/watchable.rb b/lib/dtas/watchable.rb index 36e8644..60bade0 100644 --- a/lib/dtas/watchable.rb +++ b/lib/dtas/watchable.rb @@ -1,14 +1,12 @@ # Copyright (C) 2013-2015 all contributors # License: GPLv3 or later begin - require 'sleepy_penguin' -rescue LoadError -end +require 'sleepy_penguin' # used to restart DTAS::Source::SplitFX processing in dtas-player # if the YAML file is edited -module DTAS::Watchable - class InotifyReadableIter < SleepyPenguin::Inotify +module DTAS::Watchable # :nodoc: + class InotifyReadableIter < SleepyPenguin::Inotify # :nodoc: def self.new super(:CLOEXEC) end @@ -62,4 +60,7 @@ module DTAS::Watchable srv.wait_ctl(@ino, :delete) @ino = @ino.close end -end if defined?(SleepyPenguin::Inotify) +end + +rescue LoadError +end -- cgit v1.2.3-24-ge0c7