Documentize

generates a ruby file with a TomDoc skeletons from existing ruby files

Pass in a cluttered, or just undocumented ruby file and get back a well-spaced file with a TomDoc Skeleton for easy doc writing

Installation

run the following in your console:

$ gem install documentize

Usage

Documentize takes any ruby file as an argument in the CLI, relative to your current working directory:

$ documentize my_ruby_file.rb

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/SampsonCrowley/documentize

License

The gem is available as open source under the terms of the MIT License.