Permalink
Browse files

added yard documentation support and started documenting the Call and…

… Form clases
  • Loading branch information...
2 parents 9f8776c + d83432a commit b75ab5223552e9834cd1ab42ab1d9d26c843f666 @tcocca committed Jul 2, 2011
Showing with 339 additions and 140 deletions.
  1. +11 −3 .gitignore
  2. +2 −0 Gemfile.lock
  3. +21 −15 Rakefile
  4. +239 −43 lib/pdftk_forms/call.rb
  5. +64 −78 lib/pdftk_forms/form.rb
  6. +2 −1 pdftk_forms.gemspec
View
@@ -4,20 +4,28 @@
## TEXTMATE
*.tmproj
tmtags
+
## EMACS
*~
\#*
.\#*
+
## VIM
*.swp
+
+## RubyMine
+/.idea/
+
## PROJECT::GENERAL
coverage
rdoc
pkg
+
## PROJECT::SPECIFIC
-Gemfile.lock
*.gem
pkg/*
.bundle
-## RubyMine
-/.idea/
+
+## YARD
+/.yardoc/
+/doc/
View
@@ -18,6 +18,7 @@ GEM
rspec-expectations (2.6.0)
diff-lcs (~> 1.1.2)
rspec-mocks (2.6.0)
+ yard (0.7.2)
PLATFORMS
ruby
@@ -26,3 +27,4 @@ DEPENDENCIES
pdftk_forms!
rake (>= 0.8.7)
rspec (~> 2.6.0)
+ yard
View
@@ -1,23 +1,29 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'rubygems'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :test => :spec
-task :default => :spec
+begin
+ require 'bundler'
+ Bundler::GemHelper.install_tasks
+rescue LoadError
+ task(:build){abort "`gem install bundler` to build gem"}
+ task(:install){abort "`gem install bundler` to install gem"}
+ task(:release){abort "`gem install bundler` to release gem"}
+end
begin
- require 'rdoc/task'
+ require 'rspec/core/rake_task'
+ RSpec::Core::RakeTask.new
rescue LoadError
- require 'rake/rdoctask'
+ task(:spec){abort "`gem install rspec` to run specs"}
end
-Rake::RDocTask.new do |rdoc|
- version = File.exist?('VERSION') ? File.read('VERSION') : ""
+task :test => :spec
+task :default => :spec
- rdoc.rdoc_dir = 'rdoc'
- rdoc.title = "rash #{version}"
- rdoc.rdoc_files.include('README*')
- rdoc.rdoc_files.include('lib/**/*.rb')
+begin
+ require 'yard'
+ YARD::Rake::YardocTask.new do |t|
+ t.options << "--files" << "CHANGELOG.rdoc,LICENSE"
+ end
+rescue LoadError
+ task(:yardoc){abort "`gem install yard` to generate documentation"}
end
Oops, something went wrong.

0 comments on commit b75ab52

Please sign in to comment.