0
@@ -1,6 +1,7 @@
0
 require 'rubygems'
0
 require 'rake'
0
 require 'spec/rake/spectask'
0
+require "rake/rdoctask"
0
 
0
 task :default => [:spec]
0
 
0
@@ -16,3 +17,15 @@ task :stats do
0
                       ["Specs",     "spec"] ).to_s
0
 end
0
 
0
+desc "genrates documentation"
0
+Rake::RDocTask.new do |rdoc|
0
+  rdoc.rdoc_files.include( "README",
0
+                           "COPYING",
0
+                           "LICENSE", "lib/" )
0
+  rdoc.main     = "README"
0
+  rdoc.rdoc_dir = "doc/html"
0
+  rdoc.title    = "Prawn Documentation"
0
+end
0
+
0
+
0
+

0
@@ -95,7 +95,7 @@ module Prawn
0
             
0
      # Creates and advances to a new page in the document.
0
      # Runs the <tt>:on_page_start</tt> lambda if one was provided at
0
-     # document creation time (See Document.initialize).  
0
+     # document creation time (See Document.new).  
0
      #                                
0
      def start_new_page
0
        finish_page_content if @page_content
0
@@ -129,7 +129,7 @@ module Prawn
0
       @pages.data[:Count]
0
     end
0
        
0
-    # Renders the PDF document, returning a string by default. 
0
+    # Renders the PDF document to string
0
     #
0
     def render
0
       output = StringIO.new       
0
@@ -159,37 +159,79 @@ module Prawn
0
       @bounding_box
0
     end
0
 
0
+    # Moves up the document by n points
0
+    # 
0
     def move_up(n)
0
       self.y += n
0
     end
0
 
0
+    # Moves down the document by n point
0
+    # 
0
     def move_down(n)
0
       self.y -= n
0
     end
0
 
0
+   
0
+    # Moves down the document and then executes a block.
0
+    #
0
+    #   pdf.text "some text"
0
+    #   pdf.pad_top(100) do
0
+    #     pdf.text "This is 100 points below the previous line of text"
0
+    #   end
0
+    #   pdf.text "This text appears right below the previous line of text"
0
+    #
0
     def pad_top(y)
0
       move_down(y)
0
       yield
0
     end
0
 
0
+    # Executes a block then moves down the document
0
+    #
0
+    #   pdf.text "some text"
0
+    #   pdf.pad_bottom(100) do
0
+    #     pdf.text "This text appears right below the previous line of text"
0
+    #   end
0
+    #   pdf.text "This is 100 points below the previous line of text"
0
+    #
0
     def pad_bottom(y)
0
       yield
0
       move_down(y)
0
     end
0
 
0
+    # Moves down the document by y, executes a block, then moves down the
0
+    # document by y again.
0
+    #
0
+    #   pdf.text "some text"
0
+    #   pdf.pad(100) do
0
+    #     pdf.text "This is 100 points below the previous line of text"  
0
+    #   end
0
+    #   pdf.text "This is 100 points below the previous line of text"
0
+    #
0
     def pad(y)
0
       move_down(y)
0
       yield
0
       move_down(y)
0
     end
0
 
0
+
0
+    # Builds and renders a Document::Table object from raw data.
0
+    # For details on the options that can be passed, see
0
+    # Document::Table.new
0
+    #
0
+    #   data = [["Gregory","Brown"],["James","Healy"],["Jia","Wu"]]
0
+    #
0
+    #   Prawn::Document.generate("table.pdf") do
0
+    #     table data, :headers => ["First Name", "Last Name"]
0
+    #   end
0
+    #
0
     def table(data,options={})
0
       Prawn::Document::Table.new(data,self,options).draw
0
     end
0
 
0
-    # Stores the current state of the named attributes, executes the block, and
0
-    # then restores the original values after the block has executed.
0
-    def mask(*fields)
0
+   def mask(*fields) # :nodoc:
0
+     # Stores the current state of the named attributes, executes the block, and
0
+     # then restores the original values after the block has executed.
0
+     # -- I will remove the nodoc if/when this feature is a little less hacky
0
       stored = {}
0
       fields.each { |f| stored[f] = send(f) }
0
       yield