public
Fork of ctran/annotate_models
Description: Annotate ActiveRecord models
Homepage: http://agilewebdevelopment.com/plugins/annotate_models
Clone URL: git://github.com/JackDanger/annotate_models.git
Search Repo:
commit  cb016d5c8417651f272ca49fd0aa115b8618a803
tree    1afa5e0a19a135664987b37585cc343b027f56bf
parent  903ae8126280e0ff603e127bb9d496a903e25500
name age message
folder .gitignore Fri Feb 29 11:44:40 -0800 2008 Add .gitignore [ctran]
folder History.txt Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
folder License.txt Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
folder Manifest.txt Fri Feb 29 11:20:26 -0800 2008 Refactor how rake tasks are loaded [ctran]
folder README.txt Fri Feb 29 11:40:21 -0800 2008 change the gem name to annotate-models so rubyf... [ctran]
folder Rakefile Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
folder bin/ Fri Feb 29 11:20:26 -0800 2008 Refactor how rake tasks are loaded [ctran]
folder config/ Fri Feb 29 11:40:21 -0800 2008 change the gem name to annotate-models so rubyf... [ctran]
folder doc/ Fri Feb 29 11:44:04 -0800 2008 Ignore the doc dir [ctran]
folder lib/ Sun Mar 09 12:35:37 -0700 2008 fixing that the method names weren't preceeded ... [JackDanger]
folder log/ Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
folder script/ Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
folder setup.rb Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
folder tasks/ Fri Feb 29 07:52:46 -0800 2008 Add a script so don't need to rely on Sake anymore [ctran]
folder test/ Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
folder website/ Fri Feb 29 11:42:58 -0800 2008 doc change [ctran]
README.txt
== AnnotateModels

Add a comment summarizing the current schema to the top of each ActiveRecord model source file.

  # Schema as of Sun Feb 26 21:58:32 CST 2006 (schema version 7)
  #
  #  id                  :integer(11)   not null
  #  quantity            :integer(11)   
  #  product_id          :integer(11)   
  #  unit_price          :float         
  #  order_id            :integer(11)   
  #

  class LineItem < ActiveRecord::Base 
    belongs_to :product
  
   end
  
Note that this code will blow away the initial comment block in your models if it looks like it was 
previously added by annotate models, so you don't want to add additional text to an automatically 
created comment block.

== Install

  sudo gem install sake annotate_models
  
== Usage

  cd [your project]
  annotate

== Source

  http://github.com/ctran/annotate_models
  
  
== Author
   Dave Thomas
   Pragmatic Programmers, LLC

Released under the same license as Ruby. No Support. No Warranty. 


== Modifications
 - alex@pivotallabs.com
 - ctran@pragmaquest.com