Michael Granger avatar Michael Granger committed 0e401b4

De-Yarded

Comments (0)

Files changed (2)

 	###	I N S T A N C E   M E T H O D S
 	#################################################################
 
-	### Create a new shell for the specified +directory+.
-	### @param [Treequel::Directory] directory  the LDAP directory to navigate
+	### Create a new shell for the specified +directory+ (a Treequel::Directory).
 	def initialize( directory )
 		@dir        = directory
 		@uri        = directory.uri
 	attr_accessor :quit
 
 
-	### The command loop: run the shell until the user wants to quit
-	### @param [String]              bind_as    The DN of the user to bind as. If none is
-	###                                         specified, the shell will bind anonymously.
+	### The command loop: run the shell until the user wants to quit, binding as +bind_as+ if
+	### given.
 	def run( bind_as=nil )
 		@original_tty_settings = IO.read( '|-' ) or exec 'stty', '-g'
 		message "Connected to %s" % [ @uri ]
 
 
 	### Return the description of the specified +branch+ suitable for displaying in
-	### the directory listing.
-	### @param [Treequel::Branch] branch  the branch to be described
-	### @param [Fixnum] oclen             the length of the largest objectclass that 
-	###                                   will be displayed; used to calculate the 
-	###                                   width of the objectclass column.
+	### the directory listing. The +oclen+ is the width of the objectclass column.
 	def format_description( branch, oclen=40 )
 		rdn = format_rdn( branch.rdn )
 		metadatalen = oclen + 16 + 6 # oc + timestamp + whitespace
 	end
 
 
-	### Create and configure a command-line option parser for the command.
-	### @return [Trollop::Parser] the option parser
+	### Create and configure a command-line option parser (a Trollop::Parser) for the command.
 	def self::make_option_parser
 		progname = File.basename( $0 )
 		default_directory = Treequel.directory_from_config
 	end
 
 
-	### Display additional details for the specified +attrtype+.
-	### @param [Treequel::Schema::AttributeType] attrtype  the attribute type object to display
+	### Display additional details for the specified +attrtype+ (a Treequel::Schema::AttributeType).
 	def display_attrtype_details( attrtype )
 		ocs = self.directory.schema.object_classes.values.find_all do |oc|
 			( oc.must_oids | oc.may_oids ).include?( attrtype.name.to_sym )
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.