* lib/uri.rb: Add toplevel documentation. Patch by Vincent Batts.

	  [Ruby 1.9 - Bug #4690]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31555 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

8 files changed, 24 insertions, 9 deletions

diff --git a/lib/uri/common.rb b/lib/uri/common.rb
index a8786b01f5..8d4e8c6d41 100644
--- a/lib/uri/common.rb
+++ b/lib/uri/common.rb
@@ -1,3 +1,4 @@
+#--
 # = uri/common.rb
 #
 # Author:: Akira Yamada <akira@ruby-lang.org>
@@ -5,6 +6,8 @@
 # License::
 #   You can redistribute it and/or modify it under the same term as Ruby.
 #
+# See URI for general documentation
+#
 
 module URI
   # 
@@ -634,7 +637,7 @@ module URI
       DEFAULT_PARSER.unescape(*arg)
     end
     alias decode unescape
-  end
+  end # module Escape
 
   extend Escape
   include REGEXP
@@ -978,7 +981,7 @@ module URI
     end
     ary
   end
-end
+end # module URI
 
 module Kernel
 
diff --git a/lib/uri/ftp.rb b/lib/uri/ftp.rb
index a6ef692d53..53e3b28645 100644
--- a/lib/uri/ftp.rb
+++ b/lib/uri/ftp.rb
@@ -1,10 +1,11 @@
-#
 # = uri/ftp.rb
 #
 # Author:: Akira Yamada <akira@ruby-lang.org>
 # License:: You can redistribute it and/or modify it under the same term as Ruby.
 # Revision:: $Id$
 #
+# See URI for general documentation
+#
 
 require 'uri/generic'
 
diff --git a/lib/uri/generic.rb b/lib/uri/generic.rb
index a5121001e2..1bf4bcb080 100644
--- a/lib/uri/generic.rb
+++ b/lib/uri/generic.rb
@@ -1,11 +1,11 @@
-
-#
 # = uri/generic.rb
 #
 # Author:: Akira Yamada <akira@ruby-lang.org>
 # License:: You can redistribute it and/or modify it under the same term as Ruby.
 # Revision:: $Id$
 #
+# See URI for general documentation
+#
 
 require 'uri/common'
 
diff --git a/lib/uri/http.rb b/lib/uri/http.rb
index 7d63ff52f9..3b108a4878 100644
--- a/lib/uri/http.rb
+++ b/lib/uri/http.rb
@@ -1,10 +1,11 @@
-#
 # = uri/http.rb
 #
 # Author:: Akira Yamada <akira@ruby-lang.org>
 # License:: You can redistribute it and/or modify it under the same term as Ruby.
 # Revision:: $Id$
 #
+# See URI for general documentation
+#
 
 require 'uri/generic'
 
diff --git a/lib/uri/https.rb b/lib/uri/https.rb
index 767f3338ab..7d242e7e79 100644
--- a/lib/uri/https.rb
+++ b/lib/uri/https.rb
@@ -1,10 +1,11 @@
-#
 # = uri/https.rb
 #
 # Author:: Akira Yamada <akira@ruby-lang.org>
 # License:: You can redistribute it and/or modify it under the same term as Ruby.
 # Revision:: $Id$
 #
+# See URI for general documentation
+#
 
 require 'uri/http'
 
diff --git a/lib/uri/ldap.rb b/lib/uri/ldap.rb
index c7ae83732c..56d748e59e 100644
--- a/lib/uri/ldap.rb
+++ b/lib/uri/ldap.rb
@@ -1,4 +1,3 @@
-#
 # = uri/ldap.rb
 #
 # Author::
@@ -9,6 +8,8 @@
 #   You can redistribute it and/or modify it under the same term as Ruby.
 # Revision:: $Id$
 #
+# See URI for general documentation
+#
 
 require 'uri/generic'
 
diff --git a/lib/uri/ldaps.rb b/lib/uri/ldaps.rb
index bfea6ce5e7..42bbfe86ba 100644
--- a/lib/uri/ldaps.rb
+++ b/lib/uri/ldaps.rb
@@ -1,3 +1,10 @@
+# = uri/ldap.rb
+#
+# License:: You can redistribute it and/or modify it under the same term as Ruby.
+#
+# See URI for general documentation
+#
+
 require 'uri/ldap'
 
 module URI
diff --git a/lib/uri/mailto.rb b/lib/uri/mailto.rb
index 1e8f2da063..765528fb7f 100644
--- a/lib/uri/mailto.rb
+++ b/lib/uri/mailto.rb
@@ -1,10 +1,11 @@
-#
 # = uri/mailto.rb
 #
 # Author:: Akira Yamada <akira@ruby-lang.org>
 # License:: You can redistribute it and/or modify it under the same term as Ruby.
 # Revision:: $Id$
 #
+# See URI for general documentation
+#
 
 require 'uri/generic'