set_current_section

set_current_section(title, comment) Instance Public methods Sets the current section to a section with title. See also add_section

set_visibility_for

set_visibility_for(methods, visibility, singleton = false) Instance Public methods Given an array methods of method names, set the visibility of each to visibility

sort_sections

sort_sections() Instance Public methods Sorts sections alphabetically (default) or in TomDoc fashion (none, Public, Internal, Deprecated)

top_level

top_level() Instance Public methods Return the TopLevel that owns us

upgrade_to_class

upgrade_to_class(mod, class_type, enclosing) Instance Public methods Upgrades NormalModule mod in enclosing to a class_type

new

new(context) Class Public methods Allows cross-references to be created based on the given context (RDoc::Context).

resolve

resolve(name, text) Instance Public methods Returns a reference to name. If the reference is found and name is not documented text will be returned. If name is escaped name is returned. If name is not found text is returned.

read_file

read_file(filename, encoding, force_transcode = false) Class Public methods Reads the contents of filename and handles any encoding directives in the file. The content will be converted to the encoding. If the file cannot be converted a warning will be printed and nil will be returned. If force_transcode is true the document will be transcoded and any unknown character in the target encoding will be replaced with '?'

set_encoding

set_encoding(string) Class Public methods Sets the encoding of string based on the magic comment

new

new(str, safe_level = nil, trim_mode = nil, eoutvar = 'io') Class Public methods Defaults eoutvar to 'io', otherwise is identical to ERB's initialize