# RDoc::RDoc - ri - phpman

= [**RDoc::RDoc](https://www.chedong.com/phpMan.php/perldoc/RDoc%3A%3ARDoc/markdown) < Object**

(from gem rdoc-7.2.0)
------------------------------------------------------------------------
## This is the driver for generating RDoc output.  It handles file parsing
and generation of output.

## To use this class to generate RDoc output via the API, the recommended
way is:

  rdoc = [RDoc::RDoc](https://www.chedong.com/phpMan.php/perldoc/RDoc%3A%3ARDoc/markdown).new
  options = [RDoc::Options](https://www.chedong.com/phpMan.php/perldoc/RDoc%3A%3AOptions/markdown).load_options # returns an [RDoc::Options](https://www.chedong.com/phpMan.php/perldoc/RDoc%3A%3AOptions/markdown) instance
  # set extra options
  rdoc.document options

You can also generate output like the rdoc executable:

  rdoc = [RDoc::RDoc](https://www.chedong.com/phpMan.php/perldoc/RDoc%3A%3ARDoc/markdown).new
  rdoc.document argv

## Where argv is an array of strings, each corresponding to an argument
you'd give rdoc on the command line.  See rdoc --help for details.
------------------------------------------------------------------------
= **Constants:**

GENERATORS:
  This is the list of supported output generators

TEST_SUITE_DIRECTORY_NAMES:
### List of directory names skipped if test suites should be skipped

UNCONDITIONALLY_SKIPPED_DIRECTORIES:
### List of directory names always skipped


= **Class methods:**

  add_generator
  current
  current=
  new

= **Instance methods:**

  document
  error
  gather_files
  generate
  generator
  handle_pipe
  install_siginfo_handler
  last_modified
  list_files_in_directory
  normalized_file_list
  options
  output_flag_file
  parse_dot_doc_file
  parse_file
  parse_files
  remove_siginfo_handler
  remove_unparseable
  setup_output_dir
  stats
  store
  update_output_dir

= **Attributes:**

  attr_accessor generator
  attr_accessor options
  attr_accessor store
  attr_reader last_modified
  attr_reader stats