better documentation with yard

2015-06-18 09:10:25 +02:00 · 2015-06-18 09:10:25 +02:00 · 2573087671
commit 2573087671
parent 0fe6c4dc27
3 changed files with 7 additions and 0 deletions
--- a/.gitignore
+++ b/.gitignore
@ -9,6 +9,8 @@ coverage

 # documentation
 rdoc
+doc
+.yardoc/

 # Temporary files
 .DS_Store
--- a/3
+++ b/3
@ -18,6 +18,9 @@ group :development do
  gem "pry"
  gem "pry-debundle"
  gem "pry-byebug"
+
+  # documentation
+  gem "yard", require: false
 end

 group :test do
--- a/Gemfile.lock
+++ b/Gemfile.lock
@ -186,6 +186,7 @@ GEM
      thread_safe (~> 0.1)
    uuid (2.3.8)
      macaddr (~> 1.0)
+    yard (0.8.7.6)

 PLATFORMS
  ruby
@ -208,6 +209,7 @@ DEPENDENCIES
  simplecov-rcov (= 0.2.3)
  sqlite3
  uuid (= 2.3.8)
+  yard

 BUNDLED WITH
   1.10.3