~ubuntu-branches/ubuntu/quantal/ruby1.9.1/quantal

« back to all changes in this revision

Viewing changes to lib/rdoc/generator.rb

• browse files at revision 20
• compare with another revision
• download diff
• download tarball
• view history from revision 20

Show diffs side-by-side

added

removed

lib/rdoc/generator.rb

1

1

require 'rdoc'

2

2

 

3

3

##

4

 

# Namespace for generators

 

4

# RDoc uses generators to turn parsed source code in the form of an

 

5

# RDoc::CodeObject tree into some form of output.  RDoc comes with the HTML

 

6

# generator RDoc::Generator::Darkfish and an ri data generator

 

7

# RDoc::Generator::RI.

 

8

#

 

9

# = Registering a Generator

 

10

#

 

11

# Generators are registered by calling RDoc::RDoc.add_generator with the class

 

12

# of the generator:

 

13

#

 

14

#   class My::Awesome::Generator

 

15

#     RDoc::RDoc.add_generator self

 

16

#   end

 

17

#

 

18

# = Adding Options to +rdoc+

 

19

#

 

20

# Before option processing in +rdoc+, RDoc::Options will call ::setup_options

 

21

# on the generator class with an RDoc::Options instance.  The generator can

 

22

# use RDoc::Options#option_parser to add command-line options to the +rdoc+

 

23

# tool.  See OptionParser for details on how to add options.

 

24

#

 

25

# You can extend the RDoc::Options instance with additional accessors for your

 

26

# generator.

 

27

#

 

28

# = Generator Instantiation

 

29

#

 

30

# After parsing, RDoc::RDoc will instantiate a generator by calling

 

31

# #initialize with an RDoc::Options instance.

 

32

#

 

33

# RDoc will then call #generate on the generator instance and pass in an Array

 

34

# of RDoc::TopLevel instances, each representing a parsed file.  You can use

 

35

# the various class methods on RDoc::TopLevel and in the RDoc::CodeObject tree

 

36

# to create your desired output format.

5

37

 

6

38

module RDoc::Generator

7

39

end

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1