RDoc style

git-svn-id: svn+ssh://rubyforge.org/var/svn/rubygems/trunk@1874 3d4018f9-ac1a-0410-99e9-8a154d859a19

lib/rubygems/defaults.rb

@@ -1,12 +1,16 @@
 module Gem
 
-  # An Array of the default sources that come with RubyGems.
+  ##
+  # An Array of the default sources that come with RubyGems
+
   def self.default_sources
     %w[http://gems.rubyforge.org/]
   end
 
+  ##
   # Default home directory path to be used if an alternate value is not
-  # specified in the environment.
+  # specified in the environment
+
   def self.default_dir
     if defined? RUBY_FRAMEWORK_VERSION then
       File.join File.dirname(ConfigMap[:sitedir]), 'Gems',
@@ -17,24 +21,32 @@ def self.default_dir
     end
   end
 
-  # Path for gems in the user's home directory.
+  ##
+  # Path for gems in the user's home directory
+
   def self.user_dir
     File.join(Gem.user_home, '.gem', ruby_engine,
               ConfigMap[:ruby_version])
   end
 
-  # Default gem load path.
+  ##
+  # Default gem load path
+
   def self.default_path
     [user_dir, default_dir]
   end
 
-  # Deduce Ruby's --program-prefix and --program-suffix from its install name.
+  ##
+  # Deduce Ruby's --program-prefix and --program-suffix from its install name
+
   def self.default_exec_format
     baseruby = ConfigMap[:BASERUBY] || 'ruby'
     ConfigMap[:RUBY_INSTALL_NAME].sub(baseruby, '%s') rescue '%s'
   end
 
+  ##
   # The default directory for binaries
+
   def self.default_bindir
     if defined? RUBY_FRAMEWORK_VERSION then # mac framework support
       '/usr/bin'
@@ -43,23 +55,30 @@ def self.default_bindir
     end
   end
 
-  # The default system-wide source info cache directory.
+  ##
+  # The default system-wide source info cache directory
+
   def self.default_system_source_cache_dir
     File.join Gem.dir, 'source_cache'
   end
 
-  # The default user-specific source info cache directory.
+  ##
+  # The default user-specific source info cache directory
+
   def self.default_user_source_cache_dir
     File.join Gem.user_home, '.gem', 'source_cache'
   end
 
-  # A wrapper around RUBY_ENGINE const that may not be defined.
+  ##
+  # A wrapper around RUBY_ENGINE const that may not be defined
+
   def self.ruby_engine
-    if defined? RUBY_ENGINE
+    if defined? RUBY_ENGINE then
       RUBY_ENGINE
     else
       'ruby'
     end
   end
+
 end