Class RDoc::Generator::XML
In: lib/rdoc/generator/xml.rb
Parent: RDoc::Generator::HTML
CodeObject Include Context Alias Attr AnyMethod Constant Require ClassModule NormalModule SingleClass AnonClass NormalClass TopLevel RubyParser RubyToken RuntimeError Error Error AttributeFormatter AnsiFormatter OverstrikeFormatter HtmlFormatter DefaultDisplay NamedThing IncludedModule Attribute Constant MethodSummary AliasName ClassEntry TopLevelEntry Description MethodDescription ModuleDescription ClassDescription Formatter SimpleFormatter HTML HTMLInOne XML CHM Context Method Class File Element Edge Node Subgraph Digraph SimpleElement Port Options Diagram Fortran95parser RDoc SimpleParser Token Markup TemplatePage Stats C_Parser NameDescriptor Cache Reader Writer Driver MethodEntry RI AllReferences Display Paths RI MarkUp Generator TokenStream ParserFactory DOT RDoc dot/f_4.png

Generate XML output as one big file

Methods

build_class_list   build_indices   for   gen_an_index   gen_class_index   gen_file_index   gen_into   gen_method_index   generate   generate_xml   new  

Public Class methods

for(options)

Standard generator factory

Public Instance methods

build_indices()

Generate:

  • a list of HtmlFile objects for each TopLevel object.
  • a list of HtmlClass objects for each first level class or module in the TopLevel objects
  • a complete list of all hyperlinkable terms (file, class, module, and method names)
generate(info)

Build the initial indices and output objects based on an array of TopLevel objects containing the extracted information.

generate_xml()

Generate all the HTML. For the one-file case, we generate all the information in to one big hash

[Validate]