index_pages() Instance Public methods Adds pages to the index

search_string(string) Instance Public methods Removes whitespace and downcases string

aref_to(target_path) Instance Public methods Generates a relative URL from this object's path to target_path

as_href(from_path) Instance Public methods Generates a relative URL from from_path to this object's path

cvs_url(url, full_path) Instance Public methods Build a webcvs URL starting for the given url with full_path appended as the destination path. If url contains '%s' full_path will be will replace the %s using sprintf on the url.

description() Instance Public methods Handy wrapper for marking up this object's comment

formatter() Instance Public methods Creates an RDoc::Markup::ToHtmlCrossref formatter

generate() Instance Public methods Writes the parsed data store to disk for use by ri.

initialize(store, options) Instance Protected methods Set up a new ri generator

new(name, comment) Class Public methods Creates a new Include for name with comment