From 9a627b2150a96e4257b63288e4aaebd8549edf0c Mon Sep 17 00:00:00 2001
From: Josh Holtrop <jholtrop@gmail.com>
Date: Sat, 17 Aug 2019 16:42:14 -0400
Subject: [PATCH] add YARD comments to get to 100% YARD coverage

---
 lib/rscons/ansi.rb                    | 1 +
 lib/rscons/builders/mixins/object.rb  | 1 +
 lib/rscons/builders/program.rb        | 2 ++
 lib/rscons/builders/shared_library.rb | 2 ++
 lib/rscons/builders/shared_object.rb  | 2 ++
 lib/rscons/cli.rb                     | 1 +
 lib/rscons/script.rb                  | 2 ++
 lib/rscons/util.rb                    | 1 +
 8 files changed, 12 insertions(+)

diff --git a/lib/rscons/ansi.rb b/lib/rscons/ansi.rb
index 44f8cf5..35107bd 100644
--- a/lib/rscons/ansi.rb
+++ b/lib/rscons/ansi.rb
@@ -3,6 +3,7 @@ module Rscons
   module Ansi
     class << self
 
+      # ANSI terminal reset sequence.
       RESET = "\e[0m"
 
       # Write a message to an IO with ANSI escape codes.
diff --git a/lib/rscons/builders/mixins/object.rb b/lib/rscons/builders/mixins/object.rb
index 0fb881e..b0292de 100644
--- a/lib/rscons/builders/mixins/object.rb
+++ b/lib/rscons/builders/mixins/object.rb
@@ -8,6 +8,7 @@ module Rscons
 
   module Builders
     module Mixins
+      # Mixin for builders needing to build object files.
       module Object
 
         include Depfile
diff --git a/lib/rscons/builders/program.rb b/lib/rscons/builders/program.rb
index 2097d10..b68d20c 100644
--- a/lib/rscons/builders/program.rb
+++ b/lib/rscons/builders/program.rb
@@ -8,6 +8,8 @@ module Rscons
       include Mixins::Program
 
       class << self
+        # Custom new method which will delegate to the correct class depending
+        # on the options specified.
         def new(options, *more)
           unless File.basename(options[:target])["."]
             options[:target] += options[:env].expand_varref("${PROGSUFFIX}", options[:vars])
diff --git a/lib/rscons/builders/shared_library.rb b/lib/rscons/builders/shared_library.rb
index 37a2a75..b41cb6b 100644
--- a/lib/rscons/builders/shared_library.rb
+++ b/lib/rscons/builders/shared_library.rb
@@ -8,6 +8,8 @@ module Rscons
       include Mixins::Program
 
       class << self
+        # Custom new method which will delegate to the correct class depending
+        # on the options specified.
         def new(options, *more)
           libprefix = options[:env].expand_varref("${SHLIBPREFIX}", options[:vars])
           unless File.basename(options[:target]).start_with?(libprefix)
diff --git a/lib/rscons/builders/shared_object.rb b/lib/rscons/builders/shared_object.rb
index 3a355a8..90b58ff 100644
--- a/lib/rscons/builders/shared_object.rb
+++ b/lib/rscons/builders/shared_object.rb
@@ -7,6 +7,8 @@ module Rscons
       include Mixins::Object
 
       class << self
+        # Content component to add to build path to separate objects built
+        # using this builder from others.
         def extra_path
           "_shared"
         end
diff --git a/lib/rscons/cli.rb b/lib/rscons/cli.rb
index 01c027f..df07a89 100644
--- a/lib/rscons/cli.rb
+++ b/lib/rscons/cli.rb
@@ -1,6 +1,7 @@
 require "rscons"
 require "optparse"
 
+# CLI usage string.
 USAGE = <<EOF
 Usage: #{$0} [global options] [operation] [operation options]
 
diff --git a/lib/rscons/script.rb b/lib/rscons/script.rb
index 13cb44d..1df95bf 100644
--- a/lib/rscons/script.rb
+++ b/lib/rscons/script.rb
@@ -3,6 +3,7 @@ module Rscons
   # The Script class encapsulates the state of a build script.
   class Script
 
+    # DSL available to the Rsconscript.
     class Dsl
       # Create a Dsl.
       def initialize(script)
@@ -57,6 +58,7 @@ module Rscons
       end
     end
 
+    # DSL available to the 'configure' block.
     class ConfigureDsl
       # Create a ConfigureDsl.
       #
diff --git a/lib/rscons/util.rb b/lib/rscons/util.rb
index d1d4b74..0416664 100644
--- a/lib/rscons/util.rb
+++ b/lib/rscons/util.rb
@@ -1,4 +1,5 @@
 module Rscons
+  # A collection of stand-alone utility methods.
   module Util
     class << self