Module: PuppetStrings::Markdown::PuppetTasks

Defined in:
lib/puppet-strings/markdown/puppet_tasks.rb

Class Method Summary collapse

Class Method Details

.contains_private? ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/puppet-strings/markdown/puppet_tasks.rb', line 14

def self.contains_private?
  false
end

.in_tasks ⇒ Array

Returns list of classes.

Returns:

  • (Array) —

    list of classes



9
10
11
12
 
# File 'lib/puppet-strings/markdown/puppet_tasks.rb', line 9

def self.in_tasks
  arr = YARD::Registry.all(:puppet_task).sort_by!(&:name).map!(&:to_hash)
  arr.map! { |a| PuppetStrings::Markdown::PuppetTask.new(a) }
end

.render ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/puppet-strings/markdown/puppet_tasks.rb', line 18

def self.render
  final = in_tasks.length > 0 ? "## Tasks\n\n" : ""
  in_tasks.each do |task|
    final += task.render unless task.private?
  end
  final
end

.toc_info ⇒ Object 



26
27
28
29
30
31
32
33
34
 
# File 'lib/puppet-strings/markdown/puppet_tasks.rb', line 26

def self.toc_info
  final = ["Tasks"]

  in_tasks.each do |task|
    final.push(task.toc_info)
  end

  final
end