treequel 1.6.0 → 1.7.0

data/lib/treequel/model/objectclass.rb

@@ -16,7 +16,6 @@ module Treequel::Model::ObjectClass
 
 
 	### Extension callback -- add data structures to the extending +mod+.
-	### @param [Module] mod  the mixin module to be extended
 	def self::extended( mod )
 		mod.instance_variable_set( :@model_class, Treequel::Model )
 		mod.instance_variable_set( :@model_objectclasses, [] )
@@ -65,11 +64,8 @@ module Treequel::Model::ObjectClass
 
 
 	### Set or get objectClasses that the mixin requires. Also registers the mixin with
-	### Treequel::Model.
-	### 
-	### @param [Array<#to_sym>] objectclasses  the objectClasses the mixin will apply to, as an
-	###         array of Symbols (or objects that respond to #to_sym)
-	### @return [Array<Symbol>] the objectClasses that the module requires
+	### Treequel::Model. If +objectclasses+ are given, they are set as the objectClasses the 
+	### mixin will apply to, as an array of Symbols (or objects that respond to #to_sym).
 	def model_objectclasses( *objectclasses )
 		unless objectclasses.empty?
 			@model_objectclasses = objectclasses.map( &:to_sym )
@@ -90,21 +86,18 @@ module Treequel::Model::ObjectClass
 	end
 
 
-	### @overload create( dn, entryhash={} )
-	###   Create a new instance of the mixin's model_class in the model_class's default
-	###   directory with the given +dn+ and the objectclasses specified by the mixin. If the
-	###   optional +entryhash+ is given, it will be used as the initial attributes of the
-	###   new entry.
-	###   @param [#to_s] dn                       the DN of the new model object
-	###   @param [Hash] entryhash                 attributes to set on the new entry
-	### @overload create( directory, dn, entryhash={} )
-	###   Create a new instance of the mixin's model_class in the specified +directory+
-	###   with the given +dn+ and the objectclasses specified by the mixin. If the
-	###   optional +entryhash+ is given, it will be used as the initial attributes of the
-	###   new entry.
-	###   @param [Treequel::Directory] directory  the directory to create the entry in (optional)
-	###   @param [#to_s] dn                       the DN of the new model object
-	###   @param [Hash] entryhash                 attributes to set on the new entry
+	### :call-seq:
+	###   ObjectClassModule.create( dn, entryhash={} )
+	###   ObjectClassModule.create( directory, dn, entryhash={} )
+	### 
+	### In the first form, creates a new instance of the mixin's model_class in the model_class's
+	### default directory with the given +dn+ and the objectclasses specified by the mixin. 
+	### 
+	### In the second form, creates a new instance of the mixin's model_class in the specified
+	### +directory+ with the given +dn+ and the objectclasses specified by the mixin. 
+	###
+	### If the optional +entryhash+ is given (in either form), it will be used as the initial
+	### attributes of the new entry.
 	def create( directory, dn=nil, entryhash={} )
 
 		# Shift the arguments if the first one isn't a directory
@@ -136,11 +129,6 @@ module Treequel::Model::ObjectClass
 	### Return a Branchset (or BranchCollection if the receiver has more than one
 	### base) that can be used to search the given +directory+ for entries to which
 	### the receiver applies.
-	###
-	### @param [Treequel::Directory] directory  the directory to search; if not given, this defaults
-	###                                         to the directory associated with the module's
-	###                                         model_class.
-	### @return [Treequel::Branchset, Treequel::BranchCollection]  the encapsulated search
 	def search( directory=nil )
 		directory ||= self.model_class.directory
 		bases = self.model_bases

data/lib/treequel/model.rb

@@ -81,7 +81,6 @@ class Treequel::Model < Treequel::Branch
 	### Return the Treequel::Directory the Model will use for searches, creating it if it 
 	### hasn't been created already. The default Directory will be created by calling
 	### Treequel.directory_from_config.
-	### @return [Treequel::Directory]  the default directory
 	def self::directory
 		self.directory = Treequel.directory_from_config unless @directory
 		return @directory
@@ -90,7 +89,6 @@ class Treequel::Model < Treequel::Branch
 
 	### Set the Treequel::Directory that should be used for searches. The receiving class will also
 	### be set as the #results_class of the +newdirectory+.
-	### @param [Treequel::Directory] newdirectory
 	def self::directory=( newdirectory )
 		@directory = newdirectory
 		@directory.results_class = self if @directory
@@ -98,7 +96,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Inheritance callback -- add a class-specific objectclass registry to inheriting classes.
-	### @param [Class] subclass  the inheriting class
 	def self::inherited( subclass )
 		super
 		subclass.instance_variable_set( :@objectclass_registry, SET_HASH.dup )
@@ -107,10 +104,8 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Register the given +mixin+ for the specified +objectclasses+. Instances that 
-	### have all the specified +objectclasses+ will be extended with the +mixin+.
-	###
-	### @param [Module] mixin                 the mixin to be applied; it should be extended with 
-	###                                       Treequel::Model::ObjectClass.
+	### have all the specified +objectclasses+ will be extended with the +mixin+, which should be
+	### a Module extended with Treequel::Model::ObjectClass.
 	def self::register_mixin( mixin )
 		objectclasses = mixin.model_objectclasses
 		bases = mixin.model_bases
@@ -132,7 +127,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Unregister the given +mixin+ for the specified +objectclasses+.
-	### @param [Module] mixin  the mixin that should no longer be applied
 	def self::unregister_mixin( mixin )
 		objectclasses = mixin.model_objectclasses
 		bases = mixin.model_bases
@@ -154,8 +148,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Return the mixins that should be applied to an entry with the given +objectclasses+.
-	### @param [Array<Symbol>] objectclasses  the objectclasses from the entry
-	### @return [Set<Module>] the Set of mixin modules which apply
 	def self::mixins_for_objectclasses( *objectclasses )
 		return self.objectclass_registry[:top] if objectclasses.empty?
 		ocsymbols = objectclasses.flatten.collect {|oc| oc.untaint.to_sym }
@@ -174,8 +166,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Return the mixins that should be applied to an entry with the given +dn+.
-	### @param [String] dn  the DN of the entry
-	### @return [Set<Module>] the Set of mixin modules which apply
 	def self::mixins_for_dn( dn )
 		dn_tuples = dn.downcase.split( /\s*,\s*/ )
 		dn_keys = dn_tuples.reverse.inject(['']) do |keys, dnpair|
@@ -199,8 +189,6 @@ class Treequel::Model < Treequel::Branch
 	### Create a new Treequel::Model object with the given +entry+ hash from the 
 	### specified +directory+. Overrides Treequel::Branch.new_from_entry to pass the
 	### +from_directory+ flag to mark it as unmodified.
-	### 
-	### @see Treequel::Branch.new_from_entry
 	def self::new_from_entry( entry, directory )
 		entry = Treequel::HashUtilities.stringify_keys( entry )
 		dnvals = entry.delete( 'dn' ) or
@@ -269,17 +257,18 @@ class Treequel::Model < Treequel::Branch
 
 	### Index set operator -- set attribute +attrname+ to a new +value+.
 	### Overridden to make Model objects defer writing changes until 
-	### {Treequel::Model#save} is called.
-	### 
-	### @param [Symbol, String] attrname  attribute name
-	### @param [Object] value  the attribute value
+	### Treequel::Model#save is called.
 	def []=( attrname, value )
 		attrtype = self.find_attribute_type( attrname.to_sym ) or
 			raise ArgumentError, "unknown attribute %p" % [ attrname ]
 		value = Array( value ) unless attrtype.single?
 
 		self.mark_dirty
-		@values[ attrtype.name.to_sym ] = value
+		if value
+			@values[ attrtype.name.to_sym ] = value
+		else
+			@values.delete( attrtype.name.to_sym )
+		end
 
 		# If the objectClasses change, we (may) need to re-apply mixins
 		if attrname.to_s.downcase == 'objectclass'
@@ -295,10 +284,7 @@ class Treequel::Model < Treequel::Branch
 
 	### Make the changes to the object specified by the given +attributes+.
 	### Overridden to make Model objects defer writing changes until 
-	### {Treequel::Model#save} is called.
-	### 
-	### @param attributes (see Treequel::Directory#modify)
-	### @return [TrueClass] if the merge succeeded
+	### Treequel::Model#save is called.
 	def merge( attributes )
 		attributes.each do |attrname, value|
 			self[ attrname ] = value
@@ -308,9 +294,7 @@ class Treequel::Model < Treequel::Branch
 
 	### Delete the specified attributes.
 	### Overridden to make Model objects defer writing changes until 
-	### {Treequel::Model#save} is called.
-	### 
-	### @see Treequel::Branch#delete
+	### Treequel::Model#save is called.
 	def delete( *attributes )
 		return super if attributes.empty?
 
@@ -344,7 +328,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Returns the validation errors associated with this object.
-	### @see Treequel::Model::Errors.
 	def errors
 		return @errors ||= Treequel::Model::Errors.new
 	end
@@ -360,8 +343,6 @@ class Treequel::Model < Treequel::Branch
 
 	### Validate the object with the specified +options+. Appending validation errors onto
 	### the #errors object.
-	### @param [Hash] options  options for validation.
-	### @option options [Boolean] :with_schema  whether or not to run the schema validations
 	def validate( options={} )
 		options = DEFAULT_VALIDATION_OPTIONS.merge( options )
 
@@ -377,10 +358,11 @@ class Treequel::Model < Treequel::Branch
 	end
 
 
-	### Write any pending changes in the model object to the directory.
-	### @param [Hash] opts  save options
-	### @option opts [Boolean] :raise_on_failure  (true) raise a Treequel::ValidationFailed or
-	###      Treequel::BeforeHookFailed if either the validations or before_{save,create}
+	### Write any pending changes in the model object to the directory. The valid +opts+ are:
+	### 
+	### [+:raise_on_failure+]
+	###     raise a Treequel::ValidationFailed or Treequel::BeforeHookFailed if either the
+	###     validations or before_{save,create}.
 	def save( opts={} )
 		opts = DEFAULT_SAVE_OPTIONS.merge( opts )
 
@@ -418,8 +400,7 @@ class Treequel::Model < Treequel::Branch
 	end
 
 
-	### Return any pending changes in the model object.
-	### @return [Array<LDAP::Mod>]  the changes as LDAP modifications
+	### Return any pending changes in the model object as an Array of LDAP::Mod objects.
 	def modifications
 		return unless self.modified?
 		self.log.debug "Gathering modifications..."
@@ -508,8 +489,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Returns +true+ if the receiver responds to the given method.
-	### @param [Symbol,String] sym  the name of the method to test for
-	### @return [Boolean]
 	def respond_to?( sym, include_priv=false )
 		return super if caller(1).first =~ %r{/r?spec/} &&
 			caller(1).first !~ /respond_to/ # RSpec workaround
@@ -520,7 +499,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Return the Treequel::Model::ObjectClass mixins that have been applied to the receiver.
-	### @return [Array<Module>]
 	def extensions
 		eigenclass = ( class << self; self; end )
 		return eigenclass.included_modules.find_all do |mod|
@@ -554,7 +532,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Update the object's entry with the specified +mods+.
-	### @param [Array<LDAP::Mod>] mods  the modifications to make
 	def update( mods )
 		self.log.debug "    entry already exists: updating..."
 		self.before_update( mods ) or
@@ -565,7 +542,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Create the entry for the object, using the specified +mods+ to set the attributes.
-	### @param [Array<LDAP::Mod>] mods  the modifications to set attributes
 	def create( mods )
 		self.log.debug "    entry doesn't exist: creating..."
 		self.before_create( mods ) or
@@ -576,7 +552,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Delete specific key/value +pairs+ from the entry.
-	### @param [Hash] pairs  key/value pairs to delete from the entry.
 	def delete_specific_values( pairs )
 		self.log.debug "  hash-delete..."
 
@@ -592,10 +567,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Search for the Treequel::Schema::AttributeType associated with +sym+.
-	### 
-	### @param [Symbol,String] name  the name of the attribute to find
-	### @return [Treequel::Schema::AttributeType,nil]  the associated attributeType, or nil
-	###                                                if there isn't one
 	def find_attribute_type( name )
 		attrtype = nil
 
@@ -627,17 +598,15 @@ class Treequel::Model < Treequel::Branch
 			return meth.call( *args ) if meth
 		end
 
-		self.log.debug "  checking to see if it's a traversal call"
+		# self.log.debug "  checking to see if it's a traversal call"
+
 		# Next, super to rdn-traversal if it looks like a reader but has arguments
 		plainsym, methodtype = attribute_from_method( sym )
-		self.log.debug "    method looks like a %p" % [ methodtype ]
 		return super if methodtype == :reader && !args.empty?
-		self.log.debug "  ...but it doesn't have any arguments. Finding attr type."
 
 		# Now make a method body for a new method based on what attributeType it is if 
 		# it's a valid attribute
 		attrtype = self.find_attribute_type( plainsym ) or return super
-		self.log.debug "  attrtype is: %p" % [ attrtype ]
 		methodbody = case methodtype
 			when :writer
 				self.make_writer( attrtype )
@@ -655,10 +624,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Make a reader method body for the given +attrtype+.
-	###
-	### @param [Treequel::Mode::AttributeType] attrtype  the attributeType to create the reader
-	###                                                  for.
-	### @return [Proc]  the body of the reader method.
 	def make_reader( attrtype )
 		self.log.debug "Generating an attribute reader for %p" % [ attrtype ]
 		attrname = attrtype.name
@@ -673,10 +638,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Make a writer method body for the given +attrtype+.
-	###
-	### @param [Treequel::Mode::AttributeType] attrtype  the attributeType to create the accessor
-	###                                                  for.
-	### @return [Proc]  the body of the writer method.
 	def make_writer( attrtype )
 		self.log.debug "Generating an attribute writer for %p" % [ attrtype ]
 		attrname = attrtype.name
@@ -691,10 +652,6 @@ class Treequel::Model < Treequel::Branch
 
 
 	### Make a predicate method body for the given +attrtype+.
-	###
-	### @param [Treequel::Mode::AttributeType] attrtype  the attributeType to create the method
-	###                                                  for.
-	### @return [Proc]  the body of the predicate method.
 	def make_predicate( attrtype )
 		self.log.debug "Generating an attribute predicate for %p" % [ attrtype ]
 		attrname = attrtype.name
@@ -710,7 +667,6 @@ class Treequel::Model < Treequel::Branch
 
 	### Overridden to apply applicable mixins to lazily-loaded objects once their entry 
 	### has been looked up.
-	### @return [LDAP::Entry]  the fetched entry object
 	def lookup_entry
 		if entryhash = super
 			self.apply_applicable_mixins( self.dn, entryhash )
@@ -754,8 +710,6 @@ class Treequel::Model < Treequel::Branch
 
 	### Given the symbol from an attribute accessor or predicate, return the
 	### name of the corresponding LDAP attribute/
-	### @param [Symbol] methodname  the method being called
-	### @return [Symbol] the attribute name that corresponds to the method
 	def attribute_from_method( methodname )
 
 		case methodname.to_s

data/lib/treequel/monkeypatches.rb

@@ -25,7 +25,6 @@ end # module Treequel::LDAPControlExtensions
 
 
 # Include Treequel-specific extensions as a mixin.
-# @private
 class LDAP::Control
 	include Treequel::LDAPControlExtensions
 end
@@ -46,7 +45,6 @@ end # module Treequel::LDAPModExtensions
 
 
 # Include Treequel-specific extensions as a mixin.
-# @private
 class LDAP::Mod
 	include Treequel::LDAPModExtensions
 
@@ -71,7 +69,8 @@ class LDAP::Mod
 
 	### Override the initializer to keep the +attribute+ around while the object
 	### is alive to prevent the underlying C String pointer from going away.
-	### @see line 151 of mod.c.
+	###
+	### See line 151 of mod.c.
 	def initialize( op, attribute, vals )
 		@attribute = attribute
 		_initialize_ext( op, attribute, vals )

data/lib/treequel/schema/attributetype.rb

@@ -330,7 +330,6 @@ class Treequel::Schema::AttributeType
 	# attributes.
 
 	### Test whether or not the attrinbute is a user applications attribute.
-	### @return [Boolean]  true if the attribute's USAGE is 'userApplications' (or nil)
 	def is_user?
 		return !self.is_operational?
 	end
@@ -338,7 +337,6 @@ class Treequel::Schema::AttributeType
 
 
 	### Test whether or not the attribute is an operational attribute.
-	### @return [Boolean]  true if the attribute's usage is one of the OPERATIONAL_ATTRIBUTE_USAGES
 	def is_operational?
 		usage_type = self.usage || DEFAULT_USAGE_TYPE
 		return OPERATIONAL_ATTRIBUTE_USAGES.map( &:downcase ).include?( usage_type.downcase )
@@ -347,7 +345,6 @@ class Treequel::Schema::AttributeType
 
 
 	### Test whether or not the attribute is a directory operational attribute.
-	### @return [Boolean]  true if the attribute's usage is 'directoryOperation'
 	def is_directory_operational?
 		usage_type = self.usage || DEFAULT_USAGE_TYPE
 		return usage_type == 'directoryOperation'
@@ -356,7 +353,6 @@ class Treequel::Schema::AttributeType
 
 
 	### Test whether or not the attribute is a distributed operational attribute.
-	### @return [Boolean]  true if the attribute's usage is 'distributedOperation'
 	def is_distributed_operational?
 		usage_type = self.usage || DEFAULT_USAGE_TYPE
 		return usage_type == 'distributedOperation'
@@ -365,7 +361,6 @@ class Treequel::Schema::AttributeType
 
 
 	### Test whether or not the attribute is a DSA-specific operational attribute.
-	### @return [Boolean]  true if the attribute's usage is 'dSAOperation'
 	def is_dsa_operational?
 		usage_type = self.usage || DEFAULT_USAGE_TYPE
 		return usage_type == 'dSAOperation'

data/lib/treequel/schema/objectclass.rb

@@ -52,10 +52,8 @@ class Treequel::Schema
 		end
 
 
-		### Parse an ObjectClass entry from a objectClass +description+ from a +schema+.
-		### @param [String] description       the RFC4512-format objectClass description
-		### @param [Treequel::Schema] schema  the schema object the objectClass belongs to
-		### @return [Treequel::Schema::ObjectClass]  the resulting objectclass
+		### Parse an ObjectClass entry from a RFC4512-format objectClass +description+ from a 
+		### +schema+.
 		def self::parse( schema, description )
 			oid, names, desc, obsolete, sup, kind, must, may, extensions = nil
 
@@ -166,10 +164,8 @@ class Treequel::Schema
 
 
 		### Return the objectClass's MUST OIDs as Symbols (for symbolic OIDs) or Strings (for
-		### dotted-numeric OIDs).
-		### @param [Boolean] include_sup  (true) include MUST OIDs inherited from the 
-		###                               objectClass's SUP, if it has one.
-		### @return [Array<Symbol,String>] the objectClass's MUST OIDs
+		### dotted-numeric OIDs). If include_sup is true, include MUST OIDs inherited from the 
+		### objectClass's SUP, if it has one.
 		def must_oids( include_sup=true )
 			oids = @must_oids.dup
 
@@ -193,10 +189,8 @@ class Treequel::Schema
 
 
 		### Return the objectClass's MAY OIDs as Symbols (for symbolic OIDs) or Strings (for
-		### dotted-numeric OIDs).
-		### @param [Boolean] include_sup  (true) include MAY OIDs inherited from the 
-		###                               objectClass's SUP, if it has one.
-		### @return [Array<Symbol,String>] the objectClass's MAY OIDs
+		### dotted-numeric OIDs). If include_sup is true, include MAY OIDs inherited from the 
+		### objectClass's SUP, if it has one.
 		def may_oids( include_sup=true )
 			oids = @may_oids.dup
 
@@ -258,15 +252,6 @@ class Treequel::Schema
 			return "( %s )" % [ parts.join(' ') ]
 		end
 
-		# @oid        = oid
-		# @names      = names
-		# @desc       = desc
-		# @obsolete   = obsolete ? true : false
-		# @sup_oid   = sup
-		# @must_oids  = must_oids
-		# @may_oids   = may_oids
-		# @extensions = extensions
-
 
 		### Return a human-readable representation of the object suitable for debugging
 		def inspect
@@ -295,9 +280,7 @@ class Treequel::Schema
 
 
 		### Return the SUP chain for the receiver up to 'top', including the receiver
-		### itself.
-		### @return [Array<Treequel::Schema::ObjectClass>]  the array of ObjectClass objects
-		###                                                 the receiver inherits from.
+		### itself, as an Array of Treequel::Schema::ObjectClass objects.
 		def ancestors
 			rval = [ self ]
 
@@ -309,9 +292,8 @@ class Treequel::Schema
 		end
 
 
-		### Return the string that represents the kind of objectClass
-		### the receiver represents.
-		### @return [String] one of: 'ABSTRACT', 'STRUCTURAL', 'AUXILIARY'
+		### Return the string that represents the kind of objectClass the receiver represents.
+		### It will be one of: 'ABSTRACT', 'STRUCTURAL', 'AUXILIARY'
 		def kind
 			return Treequel::Schema::OBJECTCLASS_TYPES.invert[ self.class ]
 		end

data/lib/treequel/schema.rb

@@ -42,14 +42,12 @@ class Treequel::Schema
 	### Set the strict-parsing +flag+. Setting this to a +true+ value causes schema-parsing
 	### errors to be propagated to the caller instead of handled by the constructor, which is
 	### the default behavior.
-	### @param [boolean] flag  the new flag value
 	def self::strict_parse_mode=( newval )
 		@strict_parse_mode = newval ? true : false
 	end
 
 
 	### Test whether or not strict-parsing mode is in effect.
-	### @return [boolean]  false if parse errors will be caught
 	def self::strict_parse_mode?
 		return @strict_parse_mode ? true : false
 	end
@@ -125,8 +123,6 @@ class Treequel::Schema
 
 	### Return a description of the given +descriptors+ suitable for inclusion in 
 	### an RFC4512-style schema description entry.
-	### @param [Array<String>] descriptors  an Array of descriptors
-	### @return [String] the 'qdescrs' text
 	def self::qdescrs( *descriptors )
 		descriptors.flatten!
 		if descriptors.length > 1
@@ -149,8 +145,6 @@ class Treequel::Schema
 
 	### Escape and quote the specified +string+ according to the rules in 
 	### RFC4512/2252.
-	### @param [String] string  the unescaped UTF8 string
-	### @return [String] the string after quoting and escaping
 	def self::qdstring( string )
 		return "'%s'" % [ string.to_s.gsub(/\\/, '\\\\5c').gsub(/'/, '\\\\27') ]
 	end
@@ -158,8 +152,6 @@ class Treequel::Schema
 
 	### Return a description of the given +oids+ suitable for inclusion in 
 	### an RFC4512-style schema description entry.
-	### @param [Array<String>] oids  an Array of numeric or symbolic OIDs
-	### @return [String] the oid list text
 	def self::oids( *oids )
 		oids.flatten!
 		if oids.length > 1
@@ -194,34 +186,28 @@ class Treequel::Schema
 
 	# The table of Treequel::Schema::ObjectClass objects, keyed by OID and any associated NAME 
 	# attributes (as Symbols), that describes the objectClasses in the directory's schema.
-	# @return [Treequel::Schema::Table]
 	attr_reader :object_classes
 
 	# The hash of Treequel::Schema::AttributeType objects, keyed by OID and any associated NAME
 	# attributes (as Symbols), that describe the attributeTypes in the directory's schema.
-	# @return [Treequel::Schema::Table]
 	attr_reader :attribute_types
 
 	# The hash of Treequel::Schema::LDAPSyntax objects, keyed by OID, that describe the 
 	# syntaxes in the directory's schema.
-	# @return [Treequel::Schema::Table]
 	attr_reader :ldap_syntaxes
 
 	# The hash of Treequel::Schema::MatchingRule objects, keyed by OID and any associated NAME
 	# attributes (as Symbols), that describe the matchingRules int he directory's schema.
-	# @return [Treequel::Schema::Table]
 	attr_reader :matching_rules
 
 	# The hash of Treequel::Schema::MatchingRuleUse objects, keyed by OID and any associated NAME
 	# attributes (as Symbols), that describe the attributes to which a matchingRule can be applied.
-	# @return [Treequel::Schema::Table]
 	attr_reader :matching_rule_uses
 	alias_method :matching_rule_use, :matching_rule_uses
 
 
 	### Return the Treequel::Schema::AttributeType objects that correspond to the
 	### operational attributes that are supported by the directory.
-	### @return [Array<Treequel::Schema::AttributeType>]  the operational attributes
 	def operational_attribute_types
 		return self.attribute_types.values.find_all {|attrtype| attrtype.operational? }.uniq
 	end
@@ -236,7 +222,6 @@ class Treequel::Schema
 
 
 	### Return a human-readable representation of the object suitable for debugging.
-	### @return [String]
 	def inspect
 		return %{#<%s:0x%0x %s>} % [
 			self.class.name,
@@ -361,9 +346,7 @@ class Treequel::Schema
 	end
 
 
-	### Return descriptions of the schema's artifacts.
-	### @return [Array<String>]  the descriptions of the schema's artifacts, and how many of each 
-	###     it has.
+	### Return descriptions of the schema's artifacts, and how many of each it has.
 	def ivar_descriptions
 		self.instance_variables.sort.collect do |ivar|
 			len = self.instance_variable_get( ivar ).length

data/lib/treequel/utils.rb

@@ -12,7 +12,6 @@ require 'treequel/mixins'
 module Treequel
 
 	# A alternate formatter for Logger instances.
-	# @private
 	class LogFormatter < Logger::Formatter
 
 		# The format to output unless debugging is turned on
@@ -68,7 +67,6 @@ module Treequel
 
 
 	# A ANSI-colorized formatter for Logger instances.
-	# @private
 	class ColorLogFormatter < Logger::Formatter
 		extend Treequel::ANSIColorUtilities
 
@@ -122,7 +120,6 @@ module Treequel
 
 	# An alternate formatter for Logger instances that outputs +div+ HTML
 	# fragments.
-	# @private
 	class HtmlLogFormatter < Logger::Formatter
 		include ERB::Util  # for html_escape()