rakefile

task :default => [:yard]

# task :default => ["yard"]

desc "Generate_yard_documentation"
task :yard do
  require 'yard'
  require_relative 'lib/constants'

  YARD::Rake::YardocTask.new do |t|
    # Files to include in yard documentation.
    t.files   = ["#{DIR_ROOT}/lib/**/*.rb",
                 "#{DIR_ROOT}/forgen.rb"
    ]
    # Extra options for the yard documentation
    t.options = [
        "--title=ForGen #{FORGEN_VERSION_NUMBER} Documentation",
        "--readme=#{DIR_ROOT}/README.md",
        "--output-dir=#{DIR_DOCUMENTATION_OUTPUT_PATH}" "#{DIR_DOCUMENTATION_OUTPUT_NAME}" ,
        "--no-save"
    ]

    # t.stats_options = ['--list-undoc']
  end
end

task :yard_clean do
  require_relative 'library/CONSTANTS'

  # NEED TO FIND A BETTER WAY TO CLEAN FILES AS VULNERABILITIES IN 'rm_rf'

  # Remove the documentation directory and all files in it
  FileUtils.rm_rf(DIR_DOCUMENTATION_OUTPUT_PATH + DIR_DOCUMENTATION_OUTPUT_NAME)
end