Home DocumentationReferenceAPIWebgenPathHandler ↴

class Webgen::PathHandler::Api

Path handler for Ruby API documentation via rdoc.

Constants

MANDATORY_INFOS

The mandatory meta info keys that need to be set on an api path.

Public Instance Methods

adapt_rdoc_class(api_path, klass)

Adapt a RDoc class/module object to provide a different output path depending on the output_structure meta information of the API path.

add_link_definition(api_path, link_name, url, title)

Add a link definition for the given node.

create_fragment_node_for_constant(api_path, parent_node, constant)

Create a fragment node for the given constant.

A link definition entry for the method is also created.

create_fragment_node_for_method(api_path, parent_node, method)

Create a fragment node for the given method.

A link definition entry for the method is also created.

create_fragment_nodes_for_attributes(api_path, parent_node, klass)

Creates fragment nodes for attributes under the “Attributes” fragment.

create_fragment_nodes_for_constants(api_path, klass_node, klass)

Creates fragment nodes for constants under the “Constants” fragment.

create_fragment_nodes_for_methods(api_path, klass_node, klass)

Creates fragment nodes for methods under the “Class Methods” or “Instance Methods” fragments.

create_nodes(path, blocks)

Create the feed nodes.

create_page_node_for_class(api_path, dir_node, klass, output_flag_file)

Create a page node for the given class klass and return it.

A link definition entry for the class is also created.

create_page_node_for_file(api_path, dir_node, file, output_flag_file)

Create a page node for the given file and return it.

rdoc_object(options, cache_dir)

Create the RDoc instance and use it for generating the API data.

If possible, cached data available under cache_dir is used.

rdoc_options(user_options)

Return a fully initialized RDoc::Options object.

Some of the user specified options may not be used if they would interfere with this class' job.

rdoc_store(options, cache_dir)

Return a fully initialized RDoc::Store object.