Permalink
Browse files

Hide deprecated toplevel items and implementation details from RDoc

  • Loading branch information...
1 parent 6e3c542 commit 1bf0a8b6120b96af1321d5a5ec006f76f05bd43f @drbrain drbrain committed Jun 29, 2011
View
@@ -23,7 +23,9 @@
require 'rake/version'
+# :stopdoc:
RAKEVERSION = Rake::VERSION
+# :startdoc:
require 'rbconfig'
require 'fileutils'
@@ -59,6 +61,8 @@
$trace = false
+# :stopdoc:
+#
# Some top level Constants.
FileList = Rake::FileList
View
@@ -13,6 +13,7 @@
require 'rake'
+# :stopdoc:
CLEAN = Rake::FileList["**/*~", "**/*.bak", "**/core"]
CLEAN.clear_exclude.exclude { |fn|
fn.pathmap("%f") == 'core' && File.directory?(fn)
@@ -1,15 +1,19 @@
# Copyright 2003-2010 by Jim Weirich (jim.weirich@gmail.com)
# All rights reserved.
+# :stopdoc:
+
# Configuration information about an upload host system.
-# * name :: Name of host system.
-# * webdir :: Base directory for the web information for the
-# application. The application name (APP) is appended to
-# this directory before using.
-# * pkgdir :: Directory on the host system where packages can be
-# placed.
+# name :: Name of host system.
+# webdir :: Base directory for the web information for the
+# application. The application name (APP) is appended to
+# this directory before using.
+# pkgdir :: Directory on the host system where packages can be
+# placed.
HostInfo = Struct.new(:name, :webdir, :pkgdir)
+# :startdoc:
+
# Manage several publishers as a single entity.
class CompositePublisher
def initialize
@@ -2,6 +2,11 @@
require 'rake/file_utils_ext'
module Rake
+
+ ##
+ # DSL is a module that provides #task, #desc, #namespace, etc. Use this
+ # when you'd like to use rake outside the top level scope.
+
module DSL
#--
@@ -141,7 +146,7 @@ def import(*fns)
end
end
- module DeprecatedObjectDSL
+ module DeprecatedObjectDSL # :nodoc:
Commands = Object.new.extend DSL
DSL.private_instance_methods(false).each do |name|
line = __LINE__+1
View
@@ -1,6 +1,6 @@
-# ###########################################################################
+#--
# Extensions to time to allow comparisons with an early time class.
-#
+
class Time
alias rake_original_time_compare :<=>
def <=>(other)
@@ -10,5 +10,5 @@ def <=>(other)
rake_original_time_compare(other)
end
end
-end # class Time
+end
View
@@ -1,10 +1,9 @@
require 'rbconfig'
require 'fileutils'
-# ###########################################################################
+#--
# This a FileUtils extension that defines several additional commands to be
# added to the FileUtils utility functions.
-#
module FileUtils
# Path to the currently running Ruby program
RUBY = File.join(
@@ -47,7 +46,7 @@ def sh(*cmd, &block)
end
end
- def create_shell_runner(cmd)
+ def create_shell_runner(cmd) # :nodoc:
show_command = cmd.join(" ")
show_command = show_command[0,42] + "..." unless $trace
lambda { |ok, status|
@@ -56,7 +55,7 @@ def create_shell_runner(cmd)
end
private :create_shell_runner
- def set_verbose_option(options)
+ def set_verbose_option(options) # :nodoc:
unless options.key? :verbose
options[:verbose] =
Rake::FileUtilsExt.verbose_flag == Rake::FileUtilsExt::DEFAULT ||
@@ -65,7 +64,7 @@ def set_verbose_option(options)
end
private :set_verbose_option
- def rake_system(*cmd)
+ def rake_system(*cmd) # :nodoc:
Rake::AltSystem.system(*cmd)
end
private :rake_system
@@ -7,6 +7,8 @@
require 'rake'
+# :stopdoc:
+
module Rake
GemPackageTask = Gem::PackageTask
end
View
@@ -13,6 +13,8 @@
rescue LoadError, Gem::LoadError
end
+# :stopdoc:
+
if defined?(RDoc::Task) then
module Rake
RDocTask = RDoc::Task unless const_defined? :RDocTask
View
@@ -1,7 +1,7 @@
module Rake
VERSION = '0.9.2'
- module Version
+ module Version # :nodoc: all
MAJOR, MINOR, BUILD = VERSION.split '.'
NUMBERS = [ MAJOR, MINOR, BUILD ]
end

0 comments on commit 1bf0a8b

Please sign in to comment.