aboutsummaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-06-29 03:09:34 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-06-29 03:09:34 +0000
commit926301969f7970b5a59a065dabb234cddc590e6c (patch)
tree1962225c402f5ed2c75ed14b1eece1dd665fd0b4 /lib
parent54bbc098fa1e05570e960750bf2c86d45017e575 (diff)
downloadruby-926301969f7970b5a59a065dabb234cddc590e6c.tar.gz
* math.c: Attach documentation for Math.
* object.c: Document NIL, TRUE, FALSE. * io.c: Improve grammar in ARGF comment. Document STDIN/OUT/ERR. Document ARGF global constant. * lib/rake: Hide deprecated toplevel constants from RDoc (import from rake trunk). * lib/thwait.rb: Document ThWait. * lib/mathn.rb: Hide Math redefinition from RDoc * lib/sync.rb: Add a basic comment for Sync_m, Synchronizer_m, Sync, Synchronizer. * parse.y: Document SCRIPT_LINES__. * hash.c: Document ENV class and global constant. * vm.c: Document TOPLEVEL_BINDING. * version.c: Document RUBY_* constants. * ruby.c: Document DATA and ARGV. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32281 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
-rw-r--r--lib/mathn.rb2
-rw-r--r--lib/rake.rb2
-rw-r--r--lib/rake/contrib/publisher.rb16
-rw-r--r--lib/sync.rb15
-rw-r--r--lib/thwait.rb7
5 files changed, 31 insertions, 11 deletions
diff --git a/lib/mathn.rb b/lib/mathn.rb
index fa4576f1c1..b1a959d8f8 100644
--- a/lib/mathn.rb
+++ b/lib/mathn.rb
@@ -49,7 +49,7 @@ require "mathn/complex"
unless defined?(Math.exp!)
Object.instance_eval{remove_const :Math}
- Math = CMath
+ Math = CMath # :nodoc:
end
##
diff --git a/lib/rake.rb b/lib/rake.rb
index 31fa1fa579..fc1a6a5165 100644
--- a/lib/rake.rb
+++ b/lib/rake.rb
@@ -61,6 +61,8 @@ require 'rake/application'
$trace = false
+# :stopdoc:
+#
# Some top level Constants.
FileList = Rake::FileList
diff --git a/lib/rake/contrib/publisher.rb b/lib/rake/contrib/publisher.rb
index baa9a3607d..8b11edb59c 100644
--- a/lib/rake/contrib/publisher.rb
+++ b/lib/rake/contrib/publisher.rb
@@ -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
diff --git a/lib/sync.rb b/lib/sync.rb
index bb2ad2b00f..bae05a4a99 100644
--- a/lib/sync.rb
+++ b/lib/sync.rb
@@ -41,6 +41,9 @@ unless defined? Thread
raise "Thread not available for this ruby interpreter"
end
+##
+# A module that provides a two-phase lock with a counter.
+
module Sync_m
RCS_ID='-$Id$-'
@@ -298,9 +301,21 @@ module Sync_m
return ret
end
end
+
+##
+# An alias for Sync_m from sync.rb
+
Synchronizer_m = Sync_m
+##
+# A class that providesa two-phase lock with a counter. See Sync_m for
+# details.
+
class Sync
include Sync_m
end
+
+##
+# An alias for Sync from sync.rb. See Sync_m for details.
+
Synchronizer = Sync
diff --git a/lib/thwait.rb b/lib/thwait.rb
index b5574a1c28..f5876236e4 100644
--- a/lib/thwait.rb
+++ b/lib/thwait.rb
@@ -131,13 +131,12 @@ class ThreadsWait
end
end
-ThWait = ThreadsWait
+##
+# An alias for ThreadsWait from thwait.rb
+ThWait = ThreadsWait
# Documentation comments:
# - Source of documentation is evenly split between Nutshell, existing
# comments, and my own rephrasing.
# - I'm not particularly confident that the comments are all exactly correct.
-# - The history, etc., up the top appears in the RDoc output. Perhaps it would
-# be better to direct that not to appear, and put something else there
-# instead.