lib/puppet/util/rdoc.rb
# launch a rdoc documentation process
# with the files/dir passed in +files+
launch a rdoc documentation process
with the files/dir passed in +files+
launch a rdoc documentation process with the files / dir passed in + files +
def rdoc(outputdir, files, charset = nil)
    require 'rdoc/rdoc'
    require 'rdoc/options'
    require 'puppet/util/rdoc/parser'
    r = RDoc::RDoc.new
    options = [ "--fmt", "puppet",
                "--quiet",
                "--exclude", "/modules/[^/]*/spec/.*$",
                "--exclude", "/modules/[^/]*/files/.*$",
                "--exclude", "/modules/[^/]*/tests/.*$",
                "--exclude", "/modules/[^/]*/templates/.*$",
                "--op", outputdir ]
    options << "--force-update"
    options += [ "--charset", charset] if charset
    if Puppet::Util::Platform.windows? && RDoc::VERSION !~ /^[0-3]\./
      options += [ "--root", Dir.pwd.gsub(/\\/, '/')]
    end
    options += files
    r.document(options)
  end
def rdoc ( outputdir , files , charset = nil ) require 'rdoc/rdoc' require 'rdoc/options' require 'puppet/util/rdoc/parser' r = RDoc :: RDoc . new options = [ "--fmt" , "puppet" , "--quiet" , "--exclude" , "/modules/[^/]*/spec/.*$" , "--exclude" , "/modules/[^/]*/files/.*$" , "--exclude" , "/modules/[^/]*/tests/.*$" , "--exclude" , "/modules/[^/]*/templates/.*$" , "--op" , outputdir ] options << "--force-update" options += [ "--charset" , charset ] if charset if Puppet :: Util :: Platform . windows? && RDoc :: VERSION !~ / ^[0-3] \. / options += [ "--root" , Dir . pwd . gsub ( / \\ / , '/' ) ] end options += files r . document ( options ) end
launch a rdoc documentation process
with the files/dir passed in +files+
launch a rdoc documentation process with the files / dir passed in + files +
# then rdoc # load our parser # specify our own format & where to output # Rdoc root default is Dir.pwd, but the win32-dir gem monkey patches Dir.pwd # replacing Ruby's normal / with \.  When RDoc generates relative paths it # uses relative_path_from that will generate errors when the slashes don't # properly match.  This is a workaround for that issue. # launch the documentation process
outputdir
<not_specific>
files
<not_specific>
charset
<not_specific>