class Kamaze::Project::Tools::Yardoc
Tool to run “CLI::Yardoc“ and generate documentation
@see github.com/lsegal/yard/blob/49d885f29075cfef4cb954bb9247b6fbc8318cac/lib/yard/rake/yardoc_task.rb
Attributes
options[RW]
Options used by “YARD::CLI::Yardoc“
@type [Hash] @return [Hash]
Public Instance Methods
mutable_attributes()
click to toggle source
# File lib/kamaze/project/tools/yardoc.rb, line 54 def mutable_attributes [:options] end
output_dir()
click to toggle source
Get output directory (default SHOULD be “doc“)
@return [Pathname]
# File lib/kamaze/project/tools/yardoc.rb, line 45 def output_dir core.options .yield_self(&:serializer) .yield_self(&:basepath).gsub(%r{^\./+}, '') .yield_self { |path| ::Pathname.new(path) } end
run()
click to toggle source
@return [Fixnum]
# File lib/kamaze/project/tools/yardoc.rb, line 35 def run retcode = core.run retcode = retcode ? 0 : 1 if [true, false].include?(retcode) retcode end
Also aliased as: call
Protected Instance Methods
core()
click to toggle source
@return [YARD::CLI::Yardoc]
# File lib/kamaze/project/tools/yardoc.rb, line 65 def core YARD::CLI::Yardoc.new.tap do |yard| yard.parse_arguments options.to_h.each { |k, v| yard.options[k.to_sym] = v } end end
setup()
click to toggle source
# File lib/kamaze/project/tools/yardoc.rb, line 60 def setup @options ||= {} end