./templates/ruby/src/tasks/yard.rake in noe-1.1.0 vs ./templates/ruby/src/tasks/yard.rake in noe-1.2.0
- old
+ new
@@ -1,23 +1,38 @@
+# Installs a rake task to generate API documentation using yard.
+#
+# This file installs the 'rake yard' task. It is automatically generated by Noe from
+# your .noespec file, and should therefore be configured there, under the
+# variables/rake_tasks/yard entry, as illustrated below:
+#
+# variables:
+# rake_tasks:
+# yard:
+# files: lib/**/*.rb
+# options: []
+# ...
+#
+# If you have specific needs requiring manual intervention on this file,
+# don't forget to set safe-override to false in your noe specification:
#
-# Install a rake task to generate API documentation using
-# yard.
+# template-info:
+# manifest:
+# tasks/yard.rake:
+# safe-override: false
#
-# More information about yard: http://yardoc.org/
-# This file has been written to conform to yard v0.6.4
+# This file has been written to conform to yard v0.6.4. More information about
+# yard and the rake task installed below can be found on http://yardoc.org/
#
-# About project documentation
begin
require "yard"
desc "Generate yard documentation"
YARD::Rake::YardocTask.new(:yard) do |t|
- # Array of options passed to the commandline utility
- # See 'yardoc --help' about this
- t.options = %w{--output-dir doc/api - README.md CHANGELOG.md LICENCE.md}
+ # Array of options passed to yardoc commandline. See 'yardoc --help' about this
+ t.options = +{rake_tasks.yard.options}
# Array of ruby source files (and any extra documentation files
# separated by '-')
- t.files = ['lib/**/*.rb']
+ t.files = +{rake_tasks.yard.files}
# A proc to call before running the task
# t.before = proc{ }
# A proc to call after running the task