Type:
Class

A parser is simple a class that subclasses RDoc::Parser and implements scan to fill in an RDoc::TopLevel with parsed data.

The initialize method takes an RDoc::TopLevel to fill with parsed content, the name of the file to be parsed, the content of the file, an RDoc::Options object and an RDoc::Stats object to inform the user of parsed items. The scan method is then called to parse the file and must return the RDoc::TopLevel object. By calling super these items will be set for you.

In order to be used by RDoc the parser needs to register the file extensions it can parse. Use ::parse_files_matching to register extensions.

require 'rdoc'

class RDoc::Parser::Xyz < RDoc::Parser
  parse_files_matching /\.xyz$/

  def initialize top_level, file_name, content, options, stats
    super

    # extra initialization if needed
  end

  def scan
    # parse file and fill in @top_level
  end
end
skip_optional_do_after_expression
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Parser/RDoc::Parser::Ruby

skip_optional_do_after_expression() Instance Public methods while, until, and

2025-01-10 15:47:30
look_for_directives_in
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Parser/RDoc::Parser::C

look_for_directives_in(context, comment) Instance Public methods Look for directives

2025-01-10 15:47:30
parse_method
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Parser/RDoc::Parser::Ruby

parse_method(container, single, tk, comment) Instance Public methods Parses

2025-01-10 15:47:30
remove_commented_out_lines
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Parser/RDoc::Parser::C

remove_commented_out_lines() Instance Public methods Removes lines that are

2025-01-10 15:47:30
do_missing
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Parser/RDoc::Parser::C

do_missing() Instance Public methods Creates classes and module that were missing

2025-01-10 15:47:30
parse_class
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Parser/RDoc::Parser::Ruby

parse_class(container, single, tk, comment) Instance Public methods Parses a

2025-01-10 15:47:30
parse_entries
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Parser/RDoc::Parser::ChangeLog

parse_entries() Instance Public methods Parses the entries in the

2025-01-10 15:47:30
handle_method
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Parser/RDoc::Parser::C

handle_method(type, var_name, meth_name, function, param_count, source_file = nil) Instance Public methods

2025-01-10 15:47:30
get_bool
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Parser/RDoc::Parser::Ruby

get_bool() Instance Public methods Looks for a true or false token. Returns

2025-01-10 15:47:30
do_methods
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Parser/RDoc::Parser::C

do_methods() Instance Public methods Scans content for rb_define_method, rb

2025-01-10 15:47:30