Class: YARD::Rake::YardocTask
- Inherits:
-
Rake::TaskLib
- Object
- Rake::TaskLib
- YARD::Rake::YardocTask
- Defined in:
- lib/yard/rake/yardoc_task.rb
Overview
The rake task to run CLI::Yardoc and generate documentation.
Instance Attribute Summary collapse
-
#after ⇒ Proc
Runs a
Proc
after the task. -
#before ⇒ Proc
Runs a
Proc
before the task. -
#files ⇒ Array<String>
The Ruby source files (and any extra documentation files separated by ‘-’) to process.
-
#name ⇒ String
The name of the task.
-
#options ⇒ Array<String>
Options to pass to CLI::Yardoc.
-
#stats_options ⇒ Array<String>
Options to pass to CLI::Stats.
-
#verifier ⇒ Verifier, Proc
An optional Verifier to run against all objects being generated.
Instance Method Summary collapse
-
#initialize(name = :yard) {|_self| ... } ⇒ YardocTask
constructor
Creates a new task with name
name
.
Constructor Details
#initialize(name = :yard) {|_self| ... } ⇒ YardocTask
Creates a new task with name name
.
50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/yard/rake/yardoc_task.rb', line 50 def initialize(name = :yard) @name = name @options = [] @stats_options = [] @files = [] yield self if block_given? self. += ENV['OPTS'].split(/[ ,]/) if ENV['OPTS'] self.files += ENV['FILES'].split(/[ ,]/) if ENV['FILES'] self. << '--no-stats' unless .empty? define end |
Instance Attribute Details
#after ⇒ Proc
Runs a Proc
after the task
36 37 38 |
# File 'lib/yard/rake/yardoc_task.rb', line 36 def after @after end |
#before ⇒ Proc
Runs a Proc
before the task
32 33 34 |
# File 'lib/yard/rake/yardoc_task.rb', line 32 def before @before end |
#files ⇒ Array<String>
The Ruby source files (and any extra documentation files separated by ‘-’) to process.
28 29 30 |
# File 'lib/yard/rake/yardoc_task.rb', line 28 def files @files end |
#name ⇒ String
The name of the task
11 12 13 |
# File 'lib/yard/rake/yardoc_task.rb', line 11 def name @name end |
#options ⇒ Array<String>
Options to pass to CLI::Yardoc
15 16 17 |
# File 'lib/yard/rake/yardoc_task.rb', line 15 def @options end |
#stats_options ⇒ Array<String>
Options to pass to CLI::Stats
19 20 21 |
# File 'lib/yard/rake/yardoc_task.rb', line 19 def @stats_options end |
#verifier ⇒ Verifier, Proc
Returns an optional Verifier to run against all objects being generated. Any object that the verifier returns false for will be excluded from documentation. This attribute can also be a lambda.
42 43 44 |
# File 'lib/yard/rake/yardoc_task.rb', line 42 def verifier @verifier end |