Class RDoc::C_Parser
In: parsers/parse_c.rb
Parent: Object

See rdoc/c_parse.rb

Methods

new   scan  

Public Class methods

new(top_level, file_name, body, options, stats)

prepare to parse a C file

[Source]

     # File parsers/parse_c.rb, line 175
175:     def initialize(top_level, file_name, body, options, stats)
176:       @known_classes = KNOWN_CLASSES.dup
177:       @body = handle_tab_width(handle_ifdefs_in(body))
178:       @options = options
179:       @stats   = stats
180:       @top_level = top_level
181:       @classes = Hash.new
182:       @file_dir = File.dirname(file_name)
183:       @progress = $stderr unless options.quiet
184:     end

Public Instance methods

scan()

Extract the classes/modules and methods from a C file and return the corresponding top-level object

[Source]

     # File parsers/parse_c.rb, line 188
188:     def scan
189:       remove_commented_out_lines
190:       do_classes
191:       do_constants
192:       do_methods
193:       do_includes
194:       do_aliases
195:       @top_level
196:     end

[Validate]