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)
-
- (Proc) after
Runs a
Proc
after the task. -
- (Proc) before
Runs a
Proc
before the task. -
- (Array<String>) files
The Ruby source files (and any extra documentation files separated by '-') to process.
-
- (String) name
The name of the task.
-
- (Array<String>) options
Options to pass to CLI::Yardoc.
-
- (Array<String>) stats_options
Options to pass to CLI::Stats.
-
- (Verifier, Proc) verifier
An optional Verifier to run against all objects being generated.
Instance Method Summary (collapse)
-
- (void) define
protected
Defines the rake task.
-
- (YardocTask) initialize(name = :yard) {|_self| ... }
constructor
Creates a new task with name
name
.
Constructor Details
- (YardocTask) initialize(name = :yard) {|_self| ... }
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 self..empty? define end |
Instance Attribute Details
- (Proc) after
Runs a Proc
after the task
36 37 38 |
# File 'lib/yard/rake/yardoc_task.rb', line 36 def after @after end |
- (Proc) before
Runs a Proc
before the task
32 33 34 |
# File 'lib/yard/rake/yardoc_task.rb', line 32 def before @before end |
- (Array<String>) files
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 |
- (String) name
The name of the task
11 12 13 |
# File 'lib/yard/rake/yardoc_task.rb', line 11 def name @name end |
- (Array<String>) options
Options to pass to CLI::Yardoc
15 16 17 |
# File 'lib/yard/rake/yardoc_task.rb', line 15 def @options end |
- (Array<String>) stats_options
Options to pass to CLI::Stats
19 20 21 |
# File 'lib/yard/rake/yardoc_task.rb', line 19 def @stats_options end |
- (Verifier, Proc) verifier
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 |
Instance Method Details
- (void) define (protected)
This method returns an undefined value.
Defines the rake task
68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/yard/rake/yardoc_task.rb', line 68 def define desc "Generate YARD Documentation" unless ::Rake.application.last_comment task(name) do before.call if before.is_a?(Proc) yardoc = YARD::CLI::Yardoc.new yardoc.[:verifier] = verifier if verifier yardoc.run *( + files) YARD::CLI::Stats.run(*( + ['--use-cache'])) unless .empty? after.call if after.is_a?(Proc) end end |