Table of Contents - dox-2.1.0 Documentation
Classes and Modules
- Dox
- Dox::Config
- Dox::DSL
- Dox::DSL::Action
- Dox::DSL::AttrProxy
- Dox::DSL::Documentation
- Dox::DSL::Resource
- Dox::DSL::ResourceGroup
- Dox::DSL::Syntax
- Dox::Entities
- Dox::Entities::Action
- Dox::Entities::Example
- Dox::Entities::Resource
- Dox::Entities::ResourceGroup
- Dox::Errors
- Dox::Errors::FileNotFoundError
- Dox::Errors::FolderNotFoundError
- Dox::Errors::InvalidActionError
- Dox::Errors::InvalidResourceError
- Dox::Errors::InvalidResourceGroupError
- Dox::Formatter
- Dox::Formatter::CurrentExample
- Dox::Formatters
- Dox::Formatters::Base
- Dox::Formatters::Json
- Dox::Formatters::Multipart
- Dox::Formatters::Plain
- Dox::Formatters::Xml
- Dox::Printers
- Dox::Printers::ActionPrinter
- Dox::Printers::BasePrinter
- Dox::Printers::DocumentPrinter
- Dox::Printers::ExampleRequestPrinter
- Dox::Printers::ExampleResponsePrinter
- Dox::Printers::ResourceGroupPrinter
- Dox::Printers::ResourcePrinter
- Dox::Util
- Dox::Util::Http
Methods
- ::config — Dox
- ::configure — Dox
- ::full_headers_whitelist — Dox
- ::new — Dox::DSL::Action
- ::new — Dox::DSL::Documentation
- ::new — Dox::DSL::Resource
- ::new — Dox::DSL::ResourceGroup
- ::new — Dox::Entities::Action
- ::new — Dox::Entities::Example
- ::new — Dox::Entities::Resource
- ::new — Dox::Entities::ResourceGroup
- ::new — Dox::Formatter
- ::new — Dox::Formatters::Base
- ::new — Dox::Formatters::Multipart
- ::new — Dox::Printers::BasePrinter
- ::new — Dox::Printers::DocumentPrinter
- ::verb? — Dox::Util::Http
- #_subjects — Dox::DSL::Syntax
- #acquire_defined_params — Dox::Entities::Action
- #acquire_desc — Dox::Printers::DocumentPrinter
- #acquire_header_params — Dox::Printers::ExampleRequestPrinter
- #acquire_path_params — Dox::Entities::Action
- #action — Dox::DSL::Documentation
- #action_printer — Dox::Printers::ResourcePrinter
- #add_action — Dox::Printers::ActionPrinter
- #add_action_params — Dox::Printers::ActionPrinter
- #add_content — Dox::Printers::ExampleRequestPrinter
- #add_content — Dox::Printers::ExampleResponsePrinter
- #add_content_name — Dox::Printers::ExampleRequestPrinter
- #add_content_name — Dox::Printers::ExampleResponsePrinter
- #add_desc — Dox::Printers::ExampleRequestPrinter
- #add_desc — Dox::Printers::ExampleResponsePrinter
- #add_example — Dox::Printers::ExampleRequestPrinter
- #add_example — Dox::Printers::ExampleResponsePrinter
- #add_example_request — Dox::Printers::ExampleRequestPrinter
- #add_example_response — Dox::Printers::ExampleResponsePrinter
- #add_headers — Dox::Printers::ExampleResponsePrinter
- #add_new_header_params — Dox::Printers::ExampleRequestPrinter
- #add_resource_group — Dox::Printers::ResourceGroupPrinter
- #add_resources — Dox::Printers::ResourcePrinter
- #add_schema — Dox::Printers::ExampleRequestPrinter
- #add_schema — Dox::Printers::ExampleResponsePrinter
- #add_schema_to_hash — Dox::Printers::ExampleResponsePrinter
- #add_status_desc — Dox::Printers::ExampleResponsePrinter
- #add_statuses — Dox::Printers::ExampleResponsePrinter
- #add_to_groups — Dox::Printers::ResourcePrinter
- #add_to_tags — Dox::Printers::ResourcePrinter
- #adjust_description — Dox::Printers::DocumentPrinter
- #body — Dox::Printers::DocumentPrinter
- #config — Dox::DSL::Action
- #config — Dox::DSL::Documentation
- #config — Dox::DSL::Resource
- #config — Dox::DSL::ResourceGroup
- #const_missing — Dox::DSL::Syntax
- #desc_folder_path= — Dox::Config
- #descriptions_location= — Dox::Config
- #document — Dox::DSL::Syntax
- #dump_summary — Dox::Formatter
- #example_passed — Dox::Formatter
- #extracted_multipart — Dox::Formatters::Multipart
- #filter_headers — Dox::Entities::Example
- #find_headers — Dox::Printers::ExampleRequestPrinter
- #find_headers — Dox::Printers::ExampleResponsePrinter
- #find_or_add — Dox::Printers::BasePrinter
- #find_schema — Dox::Printers::ExampleResponsePrinter
- #format — Dox::Formatters::Base
- #format — Dox::Formatters::Json
- #format — Dox::Formatters::Multipart
- #format — Dox::Formatters::Plain
- #format — Dox::Formatters::Xml
- #format_content — Dox::Entities::Example
- #format_desc — Dox::Printers::BasePrinter
- #formatted_body — Dox::Printers::BasePrinter
- #formatter — Dox::Entities::Example
- #group — Dox::DSL::Documentation
- #group_included? — Dox::Printers::ResourceGroupPrinter
- #group_printer — Dox::Printers::DocumentPrinter
- #guess_param_type — Dox::Entities::Action
- #header_file_path= — Dox::Config
- #headers_whitelist — Dox::Entities::Example
- #infer_subject — Dox::DSL::Syntax
- #load_or_save_action_to_resource — Dox::Formatter
- #load_or_save_group — Dox::Formatter
- #load_or_save_resource_to_group — Dox::Formatter
- #method_missing — Dox::DSL::AttrProxy
- #move_example_to_passed — Dox::Formatter
- #order_groups — Dox::Printers::DocumentPrinter
- #path_params — Dox::Entities::Action
- #pretty_xml — Dox::Printers::BasePrinter
- #print — Dox::Printers::ActionPrinter
- #print — Dox::Printers::BasePrinter
- #print — Dox::Printers::DocumentPrinter
- #print — Dox::Printers::ExampleRequestPrinter
- #print — Dox::Printers::ExampleResponsePrinter
- #print — Dox::Printers::ResourceGroupPrinter
- #print — Dox::Printers::ResourcePrinter
- #print_examples — Dox::Printers::ActionPrinter
- #printer — Dox::Formatter
- #read_file — Dox::Printers::BasePrinter
- #request_body — Dox::Entities::Example
- #request_fullpath — Dox::Entities::Example
- #request_headers — Dox::Entities::Example
- #request_identifier — Dox::Entities::Example
- #request_path — Dox::Entities::Example
- #request_url_query_parameters — Dox::Entities::Example
- #resource — Dox::DSL::Documentation
- #resource_printer — Dox::Printers::ResourceGroupPrinter
- #response_body — Dox::Entities::Example
- #response_headers — Dox::Entities::Example
- #response_success? — Dox::Entities::Example
- #schema_request_folder_path= — Dox::Config
- #schema_response_fail_file_path= — Dox::Config
- #schema_response_folder_path= — Dox::Config
- #stop — Dox::Formatter
- #tag — Dox::DSL::Documentation
- #template_params — Dox::Entities::Action
- #template_path — Dox::Entities::Action
- #validate! — Dox::Entities::Action
- #x_tag — Dox::DSL::Documentation