Add YARD
This commit is contained in:
parent
d8924336fa
commit
6467849a6d
5 changed files with 22 additions and 0 deletions
4
.gitignore
vendored
4
.gitignore
vendored
|
@ -8,6 +8,10 @@
|
|||
# Ignore bundler config.
|
||||
/.bundle/
|
||||
|
||||
# Ignore documentation.
|
||||
/doc/
|
||||
/.yardoc/
|
||||
|
||||
# Ignore all logfiles and tempfiles.
|
||||
/log/*
|
||||
/tmp/*
|
||||
|
|
6
.yardopts
Normal file
6
.yardopts
Normal file
|
@ -0,0 +1,6 @@
|
|||
--markup markdown
|
||||
--protected
|
||||
--private
|
||||
-
|
||||
README.md
|
||||
LICENSE
|
3
Gemfile
3
Gemfile
|
@ -138,6 +138,9 @@ group :development do
|
|||
# Automatically generate an entity-relationship diagram (ERD)
|
||||
# for your Rails models.
|
||||
gem 'rails-erd', '~> 1.5'
|
||||
|
||||
# YARD is a documentation generation tool for the Ruby programming language.
|
||||
gem 'yard', '~> 0.9'
|
||||
end
|
||||
|
||||
group :test do
|
||||
|
|
|
@ -359,6 +359,7 @@ GEM
|
|||
websocket-extensions (0.1.3)
|
||||
xpath (3.2.0)
|
||||
nokogiri (~> 1.8)
|
||||
yard (0.9.16)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
|
@ -406,6 +407,7 @@ DEPENDENCIES
|
|||
turbolinks (~> 5)
|
||||
uglifier (>= 1.3.0)
|
||||
web-console (>= 3.3.0)
|
||||
yard (~> 0.9)
|
||||
|
||||
RUBY VERSION
|
||||
ruby 2.5.1p57
|
||||
|
|
7
Rakefile
7
Rakefile
|
@ -19,3 +19,10 @@ begin
|
|||
rescue LoadError
|
||||
nil
|
||||
end
|
||||
|
||||
begin
|
||||
require 'yard'
|
||||
YARD::Rake::YardocTask.new
|
||||
rescue LoadError
|
||||
nil
|
||||
end
|
||||
|
|
Reference in a new issue