* lib/uri.rb: Documented (thanks Dmitry V. Sabanin).

 * lib/uri/common.rb: Ditto.
 * lib/uri/ftp.rb: Ditto.
 * lib/uri/generic.rb: Ditto.
 * lib/uri/http.rb: Ditto.
 * lib/uri/https.rb: Ditto.
 * lib/uri/ldap.rb: Ditto.
 * lib/uri/mailto.rb: Ditto.
 (All backported from 1.9)


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

1 files changed, 22 insertions, 80 deletions

diff --git a/lib/uri/ldap.rb b/lib/uri/ldap.rb
index ae85bb2164..e75cdc4552 100644
--- a/lib/uri/ldap.rb
+++ b/lib/uri/ldap.rb
@@ -1,29 +1,23 @@
 #
-# $Id$
+# = uri/ldap.rb
+#
+# Author:: 
+#  Takaaki Tateishi <ttate@jaist.ac.jp>
+#  Akira Yamada <akira@ruby-lang.org>
+# License:: 
+#   URI::LDAP is copyrighted free software by Takaaki Tateishi and Akira Yamada.
+#   You can redistribute it and/or modify it under the same term as Ruby.
+# Revision:: $Id$
 #
 
 require 'uri/generic'
 
 module URI
 
-=begin
-
-== URI::LDAP
-
-URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
-
-  Copyright (c) 2001 Takaaki Tateishi <ttate@jaist.ac.jp> and 
-  akira yamada <akira@ruby-lang.org>.
-  You can redistribute it and/or modify it under the same term as Ruby.
-
-=== Super Class
-
-((<URI::Generic>))
-
-=end
-
+  #
   # LDAP URI SCHEMA (described in RFC2255)
   # ldap://<host>/<dn>[?<attrs>[?<scope>[?<filter>[?<extensions>]]]]
+  #
   class LDAP < Generic
 
     DEFAULT_PORT = 389
@@ -44,27 +38,17 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
       SCOPE_BASE = 'base',
     ].freeze
 
-=begin
-
-=== Class Methods
-
---- URI::LDAP::build
-
---- URI::LDAP::new
-
-=end
-
     def self.build(args)
       tmp = Util::make_components_hash(self, args)
 
       if tmp[:dn]
-	tmp[:path] = tmp[:dn]
+        tmp[:path] = tmp[:dn]
       end
 
       query = []
       [:extensions, :filter, :scope, :attributes].collect do |x|
-	next if !tmp[x] && query.size == 0
-	query.unshift(tmp[x])
+        next if !tmp[x] && query.size == 0
+        query.unshift(tmp[x])
       end
 
       tmp[:query] = query.join('?')
@@ -76,7 +60,7 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
       super(*arg)
 
       if @fragment
-	raise InvalidURIError, 'bad LDAP URL'
+        raise InvalidURIError, 'bad LDAP URL'
       end
 
       parse_dn
@@ -95,12 +79,12 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
       @extensions = nil
 
       if @query
-	attrs, scope, filter, extensions = @query.split('?')
+        attrs, scope, filter, extensions = @query.split('?')
 
-	@attributes = attrs if attrs && attrs.size > 0
-	@scope      = scope if scope && scope.size > 0
-	@filter     = filter if filter && filter.size > 0
-	@extensions = extensions if extensions && extensions.size > 0
+        @attributes = attrs if attrs && attrs.size > 0
+        @scope      = scope if scope && scope.size > 0
+        @filter     = filter if filter && filter.size > 0
+        @extensions = extensions if extensions && extensions.size > 0
       end
     end
     private :parse_query
@@ -110,23 +94,13 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
 
       query = []
       [@extensions, @filter, @scope, @attributes].each do |x|
-	next if !x && query.size == 0
-	query.unshift(x)
+        next if !x && query.size == 0
+        query.unshift(x)
       end
       @query = query.join('?')
     end
     private :build_path_query
 
-=begin
-
-=== Instance Methods
-
---- URI::LDAP#dn
-
---- URI::LDAP#dn=(v)
-
-=end
-
     def dn
       @dn
     end
@@ -143,14 +117,6 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
       val
     end
 
-=begin
-
---- URI::LDAP#attributes
-
---- URI::LDAP#attributes=(v)
-
-=end
-
     def attributes
       @attributes
     end
@@ -167,14 +133,6 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
       val
     end
 
-=begin
-
---- URI::LDAP#scope
-
---- URI::LDAP#scope=(v)
-
-=end
-
     def scope
       @scope
     end
@@ -191,14 +149,6 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
       val
     end
 
-=begin
-
---- URI::LDAP#filter
-
---- URI::LDAP#filter=(v)
-
-=end
-
     def filter
       @filter
     end
@@ -215,14 +165,6 @@ URI::LDAP is copyrighted free software by Takaaki Tateishi and akira yamada.
       val
     end
 
-=begin
-
---- URI::LDAP#extensions
-
---- URI::LDAP#extensions=(v)
-
-=end
-
     def extensions
       @extensions
     end