Merge pull request #293 from colby-swandale/colby/rdoc-improvements

Rdoc improvements
ruby · Nov 30, 2018 · 80e00e2 · 80e00e2
2 parents 840f9ed + f9d736c
commit 80e00e2
Show file tree

Hide file tree

Showing 48 changed files with 60 additions and 60 deletions.
diff --git a/lib/rake/application.rb b/lib/rake/application.rb
@@ -797,7 +797,7 @@ def rakefile_location(backtrace=caller) # :nodoc:
       backtrace.find { |str| str =~ re } || ""
     end
 
-    def set_default_options
+    def set_default_options # :nodoc:
       options.always_multitask           = false
       options.backtrace                  = false
       options.build_all                  = false

diff --git a/lib/rake/dsl_definition.rb b/lib/rake/dsl_definition.rb
@@ -26,9 +26,9 @@ module DSL
     private
 
     # :call-seq:
-    #   task task_name
-    #   task task_name: dependencies
-    #   task task_name, arguments => dependencies
+    #   task(task_name)
+    #   task(task_name: dependencies)
+    #   task(task_name, arguments => dependencies)
     #
     # Declare a basic task.  The +task_name+ is always the first argument.  If
     # the task name contains a ":" it is defined in that namespace.

diff --git a/test/test_private_reader.rb b/test/test_private_reader.rb
@@ -2,9 +2,9 @@
 require File.expand_path("../helper", __FILE__)
 require "rake/private_reader"
 
-class TestPrivateAttrs < Rake::TestCase
+class TestPrivateAttrs < Rake::TestCase # :nodoc:
 
-  class Sample
+  class Sample # :nodoc:
     include Rake::PrivateReader
 
     private_reader :reader, :a

diff --git a/test/test_rake.rb b/test/test_rake.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRake < Rake::TestCase
+class TestRake < Rake::TestCase # :nodoc:
   def test_each_dir_parent
     assert_equal ["a"], alldirs("a")
     assert_equal ["a/b", "a"], alldirs("a/b")

diff --git a/test/test_rake_application.rb b/test/test_rake_application.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeApplication < Rake::TestCase
+class TestRakeApplication < Rake::TestCase # :nodoc:
 
   def setup
     super

diff --git a/test/test_rake_application_options.rb b/test/test_rake_application_options.rb
@@ -3,7 +3,7 @@
 
 TESTING_REQUIRE = []
 
-class TestRakeApplicationOptions < Rake::TestCase
+class TestRakeApplicationOptions < Rake::TestCase # :nodoc:
 
   def setup
     super

diff --git a/test/test_rake_backtrace.rb b/test/test_rake_backtrace.rb
@@ -2,7 +2,7 @@
 require File.expand_path("../helper", __FILE__)
 require "open3"
 
-class TestBacktraceSuppression < Rake::TestCase
+class TestBacktraceSuppression < Rake::TestCase # :nodoc:
   def test_bin_rake_suppressed
     paths = ["something/bin/rake:12"]
 
@@ -36,7 +36,7 @@ def test_near_system_dir_isnt_suppressed
   end
 end
 
-class TestRakeBacktrace < Rake::TestCase
+class TestRakeBacktrace < Rake::TestCase # :nodoc:
   include RubyRunner
 
   def setup

diff --git a/test/test_rake_clean.rb b/test/test_rake_clean.rb
@@ -2,7 +2,7 @@
 require File.expand_path("../helper", __FILE__)
 require "rake/clean"
 
-class TestRakeClean < Rake::TestCase
+class TestRakeClean < Rake::TestCase # :nodoc:
   def test_clean
     load "rake/clean.rb", true
 

diff --git a/test/test_rake_cpu_counter.rb b/test/test_rake_cpu_counter.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeCpuCounter < Rake::TestCase
+class TestRakeCpuCounter < Rake::TestCase # :nodoc:
 
   def setup
     super
@@ -28,7 +28,7 @@ def @cpu_counter.count; raise; end
     assert_equal(4, @cpu_counter.count_with_default)
   end
 
-  class TestClassMethod < Rake::TestCase
+  class TestClassMethod < Rake::TestCase  # :nodoc:
     def setup
       super
 

diff --git a/test/test_rake_definitions.rb b/test/test_rake_definitions.rb
@@ -2,7 +2,7 @@
 require File.expand_path("../helper", __FILE__)
 require "fileutils"
 
-class TestRakeDefinitions < Rake::TestCase
+class TestRakeDefinitions < Rake::TestCase # :nodoc:
   include Rake
 
   EXISTINGFILE = "existing"

diff --git a/test/test_rake_directory_task.rb b/test/test_rake_directory_task.rb
@@ -3,7 +3,7 @@
 require "fileutils"
 require "pathname"
 
-class TestRakeDirectoryTask < Rake::TestCase
+class TestRakeDirectoryTask < Rake::TestCase # :nodoc:
   include Rake
 
   def test_directory

diff --git a/test/test_rake_dsl.rb b/test/test_rake_dsl.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeDsl < Rake::TestCase
+class TestRakeDsl < Rake::TestCase # :nodoc:
 
   def setup
     super

diff --git a/test/test_rake_early_time.rb b/test/test_rake_early_time.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeEarlyTime < Rake::TestCase
+class TestRakeEarlyTime < Rake::TestCase # :nodoc:
   def test_create
     early = Rake::EarlyTime.instance
     assert early <= Time.now

diff --git a/test/test_rake_extension.rb b/test/test_rake_extension.rb
@@ -2,9 +2,9 @@
 require File.expand_path("../helper", __FILE__)
 require "stringio"
 
-class TestRakeExtension < Rake::TestCase
+class TestRakeExtension < Rake::TestCase # :nodoc:
 
-  module Redirect
+  module Redirect # :nodoc:
     def error_redirect
       old_err = $stderr
       result = StringIO.new
@@ -16,7 +16,7 @@ def error_redirect
     end
   end
 
-  class Sample
+  class Sample # :nodoc:
     extend Redirect
 
     def duplicate_method

diff --git a/test/test_rake_file_creation_task.rb b/test/test_rake_file_creation_task.rb
@@ -2,7 +2,7 @@
 require File.expand_path("../helper", __FILE__)
 require "fileutils"
 
-class TestRakeFileCreationTask < Rake::TestCase
+class TestRakeFileCreationTask < Rake::TestCase # :nodoc:
   include Rake
 
   DUMMY_DIR = "dummy_dir"

diff --git a/test/test_rake_file_list.rb b/test/test_rake_file_list.rb
@@ -2,8 +2,8 @@
 require File.expand_path("../helper", __FILE__)
 require "pathname"
 
-class TestRakeFileList < Rake::TestCase
-  FileList = Rake::FileList
+class TestRakeFileList < Rake::TestCase # :nodoc:
+  FileList = Rake::FileList # :nodoc:
 
   def setup
     super

diff --git a/test/test_rake_file_list_path_map.rb b/test/test_rake_file_list_path_map.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeFileListPathMap < Rake::TestCase
+class TestRakeFileListPathMap < Rake::TestCase # :nodoc:
   def test_file_list_supports_pathmap
     assert_equal ["a", "b"], FileList["dir/a.rb", "dir/b.rb"].pathmap("%n")
   end

diff --git a/test/test_rake_file_task.rb b/test/test_rake_file_task.rb
@@ -3,7 +3,7 @@
 require "fileutils"
 require "pathname"
 
-class TestRakeFileTask < Rake::TestCase
+class TestRakeFileTask < Rake::TestCase # :nodoc:
   include Rake
 
   def setup

diff --git a/test/test_rake_file_utils.rb b/test/test_rake_file_utils.rb
@@ -3,7 +3,7 @@
 require "fileutils"
 require "stringio"
 
-class TestRakeFileUtils < Rake::TestCase
+class TestRakeFileUtils < Rake::TestCase # :nodoc:
   def setup
     super
     @rake_test_sh = ENV["RAKE_TEST_SH"]
@@ -47,7 +47,7 @@ def test_ln
     assert_equal "TEST_LN\n", File.read("b")
   end
 
-  class BadLink
+  class BadLink # :nodoc:
     include Rake::FileUtilsExt
     attr_reader :cp_args
 

diff --git a/test/test_rake_functional.rb b/test/test_rake_functional.rb
@@ -3,7 +3,7 @@
 require "fileutils"
 require "open3"
 
-class TestRakeFunctional < Rake::TestCase
+class TestRakeFunctional < Rake::TestCase # :nodoc:
   include RubyRunner
 
   def setup

diff --git a/test/test_rake_invocation_chain.rb b/test/test_rake_invocation_chain.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeInvocationChain < Rake::TestCase
+class TestRakeInvocationChain < Rake::TestCase # :nodoc:
   include Rake
 
   def setup

diff --git a/test/test_rake_late_time.rb b/test/test_rake_late_time.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeLateTime < Rake::TestCase
+class TestRakeLateTime < Rake::TestCase # :nodoc:
   def test_late_time_comparisons
     late = Rake::LATE
     assert_equal late, late

diff --git a/test/test_rake_linked_list.rb b/test/test_rake_linked_list.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestLinkedList < Rake::TestCase
+class TestLinkedList < Rake::TestCase # :nodoc:
   include Rake
 
   def test_empty_list

diff --git a/test/test_rake_makefile_loader.rb b/test/test_rake_makefile_loader.rb
@@ -2,7 +2,7 @@
 require File.expand_path("../helper", __FILE__)
 require "rake/loaders/makefile"
 
-class TestRakeMakefileLoader < Rake::TestCase
+class TestRakeMakefileLoader < Rake::TestCase  # :nodoc:
   include Rake
 
   def test_parse

diff --git a/test/test_rake_multi_task.rb b/test/test_rake_multi_task.rb
@@ -2,7 +2,7 @@
 require File.expand_path("../helper", __FILE__)
 require "thread"
 
-class TestRakeMultiTask < Rake::TestCase
+class TestRakeMultiTask < Rake::TestCase # :nodoc:
   include Rake
 
   def setup

diff --git a/test/test_rake_name_space.rb b/test/test_rake_name_space.rb
@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeNameSpace < Rake::TestCase
+class TestRakeNameSpace < Rake::TestCase # :nodoc:
 
-  class TM
+  class TM # :nodoc:
     include Rake::TaskManager
   end
 

diff --git a/test/test_rake_package_task.rb b/test/test_rake_package_task.rb
@@ -2,7 +2,7 @@
 require File.expand_path("../helper", __FILE__)
 require "rake/packagetask"
 
-class TestRakePackageTask < Rake::TestCase
+class TestRakePackageTask < Rake::TestCase # :nodoc:
 
   def test_initialize
     touch "install.rb"

diff --git a/test/test_rake_path_map.rb b/test/test_rake_path_map.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakePathMap < Rake::TestCase
+class TestRakePathMap < Rake::TestCase  # :nodoc:
 
   def test_returns_self_with_no_args
     assert_equal "abc.rb", "abc.rb".pathmap

diff --git a/test/test_rake_path_map_explode.rb b/test/test_rake_path_map_explode.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakePathMapExplode < Rake::TestCase
+class TestRakePathMapExplode < Rake::TestCase # :nodoc:
   def setup
     super
 

diff --git a/test/test_rake_path_map_partial.rb b/test/test_rake_path_map_partial.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakePathMapPartial < Rake::TestCase
+class TestRakePathMapPartial < Rake::TestCase # :nodoc:
   def test_pathmap_partial
     @path = "1/2/file".dup
     def @path.call(n)

diff --git a/test/test_rake_pseudo_status.rb b/test/test_rake_pseudo_status.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakePseudoStatus < Rake::TestCase
+class TestRakePseudoStatus < Rake::TestCase # :nodoc:
   def test_with_zero_exit_status
     s = Rake::PseudoStatus.new
     assert_equal 0, s.exitstatus

diff --git a/test/test_rake_rake_test_loader.rb b/test/test_rake_rake_test_loader.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeRakeTestLoader < Rake::TestCase
+class TestRakeRakeTestLoader < Rake::TestCase # :nodoc:
 
   def setup
     super

diff --git a/test/test_rake_reduce_compat.rb b/test/test_rake_reduce_compat.rb
@@ -2,7 +2,7 @@
 require File.expand_path("../helper", __FILE__)
 require "open3"
 
-class TestRakeReduceCompat < Rake::TestCase
+class TestRakeReduceCompat < Rake::TestCase # :nodoc:
   include RubyRunner
 
   def invoke_normal(task_name)

diff --git a/test/test_rake_require.rb b/test/test_rake_require.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeRequire < Rake::TestCase
+class TestRakeRequire < Rake::TestCase # :nodoc:
   def setup
     super
     $LOAD_PATH.unshift "." if jruby17?

diff --git a/test/test_rake_rules.rb b/test/test_rake_rules.rb
@@ -2,7 +2,7 @@
 require File.expand_path("../helper", __FILE__)
 require "fileutils"
 
-class TestRakeRules < Rake::TestCase
+class TestRakeRules < Rake::TestCase # :nodoc:
   include Rake
 
   SRCFILE    = "abc.c"

diff --git a/test/test_rake_scope.rb b/test/test_rake_scope.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeScope < Rake::TestCase
+class TestRakeScope < Rake::TestCase # :nodoc:
   include Rake
 
   def test_path_against_empty_scope

diff --git a/test/test_rake_task.rb b/test/test_rake_task.rb
@@ -2,7 +2,7 @@
 require File.expand_path("../helper", __FILE__)
 require "fileutils"
 
-class TestRakeTask < Rake::TestCase
+class TestRakeTask < Rake::TestCase # :nodoc:
   include Rake
 
   def setup

diff --git a/test/test_rake_task_argument_parsing.rb b/test/test_rake_task_argument_parsing.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require File.expand_path("../helper", __FILE__)
 
-class TestRakeTaskArgumentParsing < Rake::TestCase
+class TestRakeTaskArgumentParsing < Rake::TestCase # :nodoc:
   def setup
     super