Add yard (#28)

* added yard gem * add error documentation * readd error, will remove on merge * add yardoc files to gitignore * remove ignored files * will put error docs in separate branch
LaunchPadLab · Apr 14, 2017 · 619ef7a · 619ef7a
1 parent d03c625
commit 619ef7a
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
 .DS_Store
+.yardoc
+doc
diff --git a/.yardopts b/.yardopts
@@ -0,0 +1 @@
+--markup markdown
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -8,6 +8,7 @@ GEM
   specs:
     minitest (5.10.1)
     rake (10.4.2)
+    yard (0.9.8)
 
 PLATFORMS
   ruby
@@ -16,6 +17,7 @@ DEPENDENCIES
   minitest (~> 5.10.1)
   rake (~> 10.4.2)
   token_master!
+  yard
 
 BUNDLED WITH
    1.14.5
diff --git a/Rakefile b/Rakefile
@@ -1,8 +1,13 @@
 require 'rake/testtask'
+require 'yard'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
 end
 
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+end
+
 desc "Run tests"
 task :default => :test
diff --git a/token_master.gemspec b/token_master.gemspec
@@ -16,4 +16,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rake", "~> 10.4.2"
   s.add_development_dependency "minitest", "~> 5.10.1"
+  s.add_development_dependency "yard"
 end