add YARD comments to get to 100% YARD coverage

This commit is contained in:
Josh Holtrop 2019-08-17 16:42:14 -04:00
parent 937c964c3e
commit 9a627b2150
8 changed files with 12 additions and 0 deletions

View File

@ -3,6 +3,7 @@ module Rscons
module Ansi module Ansi
class << self class << self
# ANSI terminal reset sequence.
RESET = "\e[0m" RESET = "\e[0m"
# Write a message to an IO with ANSI escape codes. # Write a message to an IO with ANSI escape codes.

View File

@ -8,6 +8,7 @@ module Rscons
module Builders module Builders
module Mixins module Mixins
# Mixin for builders needing to build object files.
module Object module Object
include Depfile include Depfile

View File

@ -8,6 +8,8 @@ module Rscons
include Mixins::Program include Mixins::Program
class << self class << self
# Custom new method which will delegate to the correct class depending
# on the options specified.
def new(options, *more) def new(options, *more)
unless File.basename(options[:target])["."] unless File.basename(options[:target])["."]
options[:target] += options[:env].expand_varref("${PROGSUFFIX}", options[:vars]) options[:target] += options[:env].expand_varref("${PROGSUFFIX}", options[:vars])

View File

@ -8,6 +8,8 @@ module Rscons
include Mixins::Program include Mixins::Program
class << self class << self
# Custom new method which will delegate to the correct class depending
# on the options specified.
def new(options, *more) def new(options, *more)
libprefix = options[:env].expand_varref("${SHLIBPREFIX}", options[:vars]) libprefix = options[:env].expand_varref("${SHLIBPREFIX}", options[:vars])
unless File.basename(options[:target]).start_with?(libprefix) unless File.basename(options[:target]).start_with?(libprefix)

View File

@ -7,6 +7,8 @@ module Rscons
include Mixins::Object include Mixins::Object
class << self class << self
# Content component to add to build path to separate objects built
# using this builder from others.
def extra_path def extra_path
"_shared" "_shared"
end end

View File

@ -1,6 +1,7 @@
require "rscons" require "rscons"
require "optparse" require "optparse"
# CLI usage string.
USAGE = <<EOF USAGE = <<EOF
Usage: #{$0} [global options] [operation] [operation options] Usage: #{$0} [global options] [operation] [operation options]

View File

@ -3,6 +3,7 @@ module Rscons
# The Script class encapsulates the state of a build script. # The Script class encapsulates the state of a build script.
class Script class Script
# DSL available to the Rsconscript.
class Dsl class Dsl
# Create a Dsl. # Create a Dsl.
def initialize(script) def initialize(script)
@ -57,6 +58,7 @@ module Rscons
end end
end end
# DSL available to the 'configure' block.
class ConfigureDsl class ConfigureDsl
# Create a ConfigureDsl. # Create a ConfigureDsl.
# #

View File

@ -1,4 +1,5 @@
module Rscons module Rscons
# A collection of stand-alone utility methods.
module Util module Util
class << self class << self