Ratch  Ratch::RDocUtils

Methods

[Validate]
Generated with Newfish 0.1.0

RDocUtils

Provides a pure-Ruby method for generating RDocs.

Public Instance Methods

.., :opt1 => val1, ...) click to toggle source

RDoc command.

    # File lib/ratch/utils/rdoc.rb, line 15
15:     def rdoc(*files)
16:       require 'rdoc/rdoc'
17: 
18:       options = Hash===files.last ? files.pop : {}
19:       options.rekey!(&:to_s)
20: 
21:       options['title'] ||= options.delete('T')
22: 
23:       options['debug']   = options['debug']   #|| debug?
24:       options['quiet']   = options['quiet']   #|| quiet?
25:       options['verbose'] = options['verbose'] #|| verbose?
26: 
27:       # apply pom (todo?)
28:       #options['title'] ||= metadata.title
29: 
30:       options = DEFAULT_RDOC_OPTIONS.merge(options)
31: 
32:       locally do
33:         rdoc = RDoc::RDoc.new
34:         opts = options.to_argv + files
35:         $stderr.puts("rdoc " + opts.join(' ')) if ($VERBOSE || $DEBUG)
36:         disable_warnings do
37:           rdoc.document(options.to_argv + files)
38:         end
39:       end
40:     end

Disabled; run with --debug to generate this.