Class RDoc::TopLevel
In: lib/gerbil/rdoc.rb
Parent: Object

Methods

all_classes   all_methods   all_modules   parse   parse_file   refresh_all_classes_and_modules  

Public Class methods

all_classes()

Returns an array of all classes recorded thus far.

all_methods()

Returns an array of RDoc::AnyMethod objects representing all methods recorded thus far.

all_modules()

Returns an array of all modules recorded thus far.

parse(aCodeString, aFileName = __FILE__)

Returns a RDoc::TopLevel object containing information parsed from the given code string. This information is also added to the global TopLevel class state, so you can access it via the class methods of the TopLevel class.

If the file name (which signifies the origin of the given code) is given, it MUST have a ".c" or ".rb" file extension. Otherwise, RDoc will ignore the given code string! :-(

parse_file(aFileName)

Returns a RDoc::TopLevel object containing information parsed from the code in the given file. This information is also added to the global TopLevel class state, so you can access it via the class methods of the TopLevel class.

The given file name MUST have a ".c" or ".rb" file extension. Otherwise, RDoc will ignore the file! :-(

refresh_all_classes_and_modules()

Update the return value of the all_classes_and_modules() method to really include every class and every module seen thus far.

[Validate]