RDoc updates

lib/warbler.rb

@@ -5,8 +5,8 @@
 # See the file LICENSE.txt for details.
 #++
 
-# Warbler is a lightweight, flexible, Rake-based system for packaging your Rails apps
-# into .war files.
+# Warbler is a lightweight, flexible, Rake-based system for packaging
+# your Ruby applications into .jar or .war files.
 module Warbler
   WARBLER_HOME = File.expand_path(File.dirname(__FILE__) + '/..') unless defined?(WARBLER_HOME)
 

lib/warbler/config.rb

@@ -10,7 +10,7 @@
 require 'warbler/traits'
 
 module Warbler
-  # Warbler war file assembly configuration class.
+  # Warbler archive assembly configuration class.
   class Config
     TOP_DIRS = %w(app config lib log vendor)
     FILE = "config/warble.rb"

lib/warbler/gems.rb

@@ -11,15 +11,15 @@ module Warbler
   # It would be easier to just use a hash.
   class Gems < Hash
     ANY_VERSION = nil
-    
+
     def initialize(gems = nil)
       if gems.is_a?(Hash)
         self.merge!(gems)
       elsif gems.is_a?(Array)
         gems.each {|gem| self << gem }
       end
     end
-    
+
     def <<(gem)
       self[gem] ||= ANY_VERSION
     end

lib/warbler/traits/bundler.rb

@@ -6,6 +6,8 @@
 
 module Warbler
   module Traits
+    # The Bundler trait uses Bundler to determine gem dependencies to
+    # be added to the project.
     class Bundler
       include Trait
 

lib/warbler/traits/gemspec.rb

@@ -6,6 +6,8 @@
 
 module Warbler
   module Traits
+    # The Gemspec trait reads a .gemspec file to determine the files,
+    # executables, require paths, and dependencies for a project.
     class Gemspec
       include Trait
 

lib/warbler/traits/jar.rb

@@ -9,6 +9,9 @@
 
 module Warbler
   module Traits
+    # The Jar trait sets up the archive layout for an executable jar
+    # project, and adds the JRuby jar files and a JarMain class to the
+    # archive.
     class Jar
       include Trait
 

lib/warbler/traits/merb.rb

@@ -6,6 +6,7 @@
 
 module Warbler
   module Traits
+    # The Merb trait adds Merb::BootLoader gem dependencies to the project.
     class Merb
       include Trait
 

lib/warbler/traits/nogemspec.rb

@@ -6,6 +6,9 @@
 
 module Warbler
   module Traits
+    # The NoGemspec trait is used when no gemspec file is found for a
+    # jar project. It assumes a standard layout including +bin+ and
+    # +lib+ directories.
     class NoGemspec
       include Trait
 

lib/warbler/traits/rack.rb

@@ -6,6 +6,7 @@
 
 module Warbler
   module Traits
+    # The Rack trait adds config.ru to a Rack-based war project.
     class Rack
       include Trait
 

lib/warbler/traits/rails.rb

@@ -6,6 +6,7 @@
 
 module Warbler
   module Traits
+    # The Rails trait invokes the Rake environment task and sets up Rails for a war-based project.
     class Rails
       include Trait
 

lib/warbler/traits/war.rb

@@ -8,6 +8,7 @@
 
 module Warbler
   module Traits
+    # The War trait sets up the layout and generates web.xml for the war project.
     class War
       include Trait