1. Michael Granger
  2. ruby-openldap

Commits

Michael Granger  committed 8fbea29

Documentation fixes, removed some YARD cruft.

  • Participants
  • Parent commits 2568fe5
  • Branches default

Comments (0)

Files changed (3)

File ext/openldap.c

View file
  • Ignore whitespace
  * Return a Hash describing the API version, vendor, extensions, etc.
  *
  *    conn.api_info
- *    # => {:api_version=>3001, :protocol_version=>3, :extensions=>["X_OPENLDAP"], 
- *          :vendor_name=>"OpenLDAP", :vendor_version=>20424} (using ==)
+ *    # => {:api_version=>3001, :protocol_version=>3, 
+ *          :extensions=>["X_OPENLDAP", "THREAD_SAFE", "X_OPENLDAP_THREAD_SAFE"], 
+ *          :vendor_name=>"OpenLDAP", :vendor_version=>20423}
  */
 static VALUE
 ropenldap_s_api_info( VALUE self )
  * Returns a hash of the versions of the extensions in .api_info[:extensions]
  *
  *    conn.api_feature_info
- *    # => 
+ *    # => {"X_OPENLDAP"=>20423, "THREAD_SAFE"=>1, "X_OPENLDAP_THREAD_SAFE"=>1}
  */
 static VALUE
 ropenldap_s_api_feature_info( VALUE self )
  * call-seq:
  *    OpenLDAP.uris   -> array
  *
- * Return 
+ * Return an Array of URIs to be contacted by the library when trying to establish a connection.
  *
- *    example code
+ *    OpenLDAP.uris
+ *    # => ['ldap://ldap.example.com:389']
  */
 static VALUE
 ropenldap_s_uris( VALUE self )

File lib/openldap.rb

View file
  • Ignore whitespace
 
 
 	class << self
-		# @return [Logger::Formatter] the log formatter that will be used when the logging 
-		#    subsystem is reset
+		# The log formatter that will be used when the logging subsystem is reset
 		attr_accessor :default_log_formatter
 
-		# @return [Logger] the logger that will be used when the logging subsystem is reset
+		# the logger that will be used when the logging subsystem is reset
 		attr_accessor :default_logger
 
-		# @return [Logger] the logger that's currently in effect
+		# the logger that's currently in effect
 		attr_accessor :logger
 		alias_method :log, :logger
 		alias_method :log=, :logger=
 
 
 	### Reset the global logger object to the default
-	### @return [void]
 	def self::reset_logger
 		self.logger = self.default_logger
 		self.logger.level = Logger::WARN
 
 
 	### Get the library version.
-	### @return [String] the library's version
 	def self::version_string( include_buildnum=false )
 		vstring = "%s %s" % [ self.name, VERSION ]
 		vstring << " (build %s)" % [ REVISION[/: ([[:xdigit:]]+)/, 1] || '0' ] if include_buildnum

File lib/openldap/exceptions.rb

View file
  • Ignore whitespace
 	### and inheriting from +superclass+.
 	def self::def_ldap_exception( classname, result_code, superclass=OpenLDAP::Error )
 		eclass = Class.new( superclass ) do
-			def initialize( message=nil )
+			def initialize( message=nil ) # :nodoc:
 				ldapmsg = OpenLDAP.err2string( self.class.result_code )
 				ldapmsg += ': ' + message if message
 				super( ldapmsg )