Sha256: 0a3ca72f217241113fffb6944c40bc7e5752ec81d6bfb04fdbaca9c351e1c304

Contents?: true

Size: 568 Bytes

Versions: 9

Compression:

Stored size: 568 Bytes

Contents

desc 'generate YARD API docs'
task :yard_api => :environment do |t|
  require 'fileutils'
  require 'yard-api/yardoc_task'

  runner = YARD::APIPlugin::YardocTask.new
  output = runner.config['output']

  puts case runner.config['format']
  when 'html'
    <<-Message
      API documentation (in HTML format) was successfully generated.
      Open #{output}/index.html in a browser.
    Message
  when 'json'
    <<-Message
      API documentation (in JSON format) was successfully generated.
      You will find the documents in #{output}/*.json
    Message
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
yard-api-1.1.2 tasks/yard_api.rake
yard-api-1.1.1 tasks/yard_api.rake
yard-api-1.1.0 tasks/yard_api.rake
yard-api-1.0.1 tasks/yard_api.rake
yard-api-1.0.0 tasks/yard_api.rake
yard-api-0.3.7 tasks/yard_api.rake
yard-api-0.3.6 tasks/yard_api.rake
yard-api-0.3.5 tasks/yard_api.rake
yard-api-0.3.4 tasks/yard_api.rake