Method: Bones::Plugins::Rdoc#initialize_rdoc

Defined in:
lib/bones/plugins/rdoc.rb

#initialize_rdocObject



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/bones/plugins/rdoc.rb', line 14

def initialize_rdoc
  ::Bones.config {
    desc 'Configuration settings for rdoc and ri'
    rdoc {

      opts  [], :desc => 'Array of rdoc options to use when generating documentation.'

      include  %w(^lib/ ^bin/ ^ext/ \.txt$ \.rdoc$), :desc => "        An array of patterns that will be used to find the files for which\n        documentation should be generated. This is an array of strings that\n        will be converted in regular expressions.\n      __\n\n      exclude  %w(extconf\\.rb$ ^version.txt), :desc => <<-__\n        An array of patterns that will be used to exclude files from rdoc\n        processing. This is an array of strings that will be converted in\n        regular expressions.\n      __\n\n      main  nil, :desc => <<-__\n        The main rdoc file for the project. This defaults to the project's\n        README file.\n      __\n\n      dir  'doc', :desc => 'Output directory for generated documentation.'\n    }\n  }\n\n  have?(:rdoc) { true }\n  have?(:rdoc_gem) { true } if defined? RDoc\nend\n"