wmiirc-rumai

commit 96107636d5b7087f7a5b282c38eba18710858ce9
parent 9b5aeb8a4dc98a510d366fa2dcfee5f49dd94728
Author: Suraj N. Kurapati <sunaku@gmail.com>
Date:   Mon, 11 Sep 2006 09:56:15 -0700

[project @ 4e4f66098976b7c655aa29a87ba2954157a5d259]

[project @ 66]
up  rdoc

Diffstat:
Rakefile
 | 
1
-
rc.rb
 | 
4
+---
wm.rb
 | 
12
++++++------

3 files changed, 7 insertions(+), 10 deletions(-)
diff --git a/Rakefile b/Rakefile
@@ -14,7 +14,6 @@ end
 Rake::RDocTask.new(:doc) do |t|
   t.rdoc_files.include('wmii*', '*.rb')
   t.rdoc_dir = 'doc'
-  t.main = 'Wmii'
 end
 
 Rake::PackageTask.new('snk_wmiirc', :noversion) do |p|
diff --git a/rc.rb b/rc.rb
@@ -17,14 +17,12 @@
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 =end
 
+require 'find'
 require 'wm'
 
 include Wmii
 include Wmii::State
 
-
-require 'find'
-
 # Returns a list of program names available in the given paths.
 def find_programs *aPaths
   aPaths.flatten!
diff --git a/wm.rb b/wm.rb
@@ -1,4 +1,4 @@
-# Abstractions for graphical stuff in wmii.
+# Abstractions for window manager stuff.
 =begin
   Copyright 2006 Suraj N. Kurapati
 
@@ -22,7 +22,7 @@ require 'fs'
 module Wmii
   SELECTION_TAG = 'SEL'
 
-  # Returns the client which has the given ID or +nil+ if not found. The search is performed within the given places if they are specified.
+  # Searches for the client with the given ID and returns it. If the client is not found, *nil* is returned. The search is performed within the given places if they are specified.
   def find_client aClientId, aArea = nil, aView = nil
     aClientId = aClientId.to_i
     needle = Client.new("/client/#{aClientId}")
@@ -143,7 +143,7 @@ module Wmii
     end
   end
 
-  # Represents the window manager at root of the file system.
+  # Head of the window manager's hierarchy.
   class Root < IxpFs::Node
     include State
 
@@ -152,7 +152,7 @@ module Wmii
     end
   end
 
-  # A graphical region in the window manager.
+  # A region in the window manager's hierarchy.
   class Node < IxpFs::Node
     include Wmii
 
@@ -369,7 +369,7 @@ module Wmii
 
     alias areas children
 
-    # Applies wmii-2 style tiling layout to this view while maintaining its order of clients. Only the first client in the primary column is kept; all others are evicted to the *top* of the secondary column. Any subsequent columns are squeezed into the *bottom* of the secondary column.
+    # Arranges the clients in this view, while maintaining their relative order, in the tiling fashion of LarsWM. Only the first client in the primary column is kept; all others are evicted to the *top* of the secondary column. Any subsequent columns are squeezed into the *bottom* of the secondary column.
     def tile!
       numAreas = self.indices.length
 
@@ -393,7 +393,7 @@ module Wmii
       end
     end
 
-    # Applies wmii-2 style grid layout to this view while maintaining its order of clients. If the maximum number of clients per column, the distribution of clients among the columns is calculated according to wmii-2 style. Only the first client in the primary column is kept; all others are evicted to the *top* of the secondary column. Any teritiary, quaternary, etc. columns are squeezed into the *bottom* of the secondary column.
+    # Arranges the clients in this view, while maintaining their relative order, in a (at best) square grid.
     def grid! aMaxClientsPerColumn = nil
       # determine client distribution
         unless aMaxClientsPerColumn