diff options
author | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2003-12-28 06:33:07 +0000 |
---|---|---|
committer | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2003-12-28 06:33:07 +0000 |
commit | 2d491003aaab3e49a02f6126af9d03d429eed284 (patch) | |
tree | e6d8a2d76367ace555bc4e76e08f54dc1414a3dd /lib/rdoc | |
parent | 8f71229356ce2be9c5da28d0f9a3f8ed383a53d4 (diff) | |
download | ruby-2d491003aaab3e49a02f6126af9d03d429eed284.tar.gz |
Add RDoc documentation for stuff in object.c
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@5330 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc')
-rw-r--r-- | lib/rdoc/parsers/parse_c.rb | 59 | ||||
-rw-r--r-- | lib/rdoc/ri/ri_formatter.rb | 2 |
2 files changed, 42 insertions, 19 deletions
diff --git a/lib/rdoc/parsers/parse_c.rb b/lib/rdoc/parsers/parse_c.rb index 086a63f4de..b8296f569d 100644 --- a/lib/rdoc/parsers/parse_c.rb +++ b/lib/rdoc/parsers/parse_c.rb @@ -124,6 +124,7 @@ module RDoc extend ParserFactory parse_files_matching(/\.(c|cc|cpp|CC)$/) + @@known_bodies = {} # prepare to parse a C file def initialize(top_level, file_name, body, options) @@ -245,24 +246,39 @@ module RDoc ############################################################ def do_methods - @body.scan(/rb_define_(singleton_method|method|module_function)\(\s*(\w+), - \s*"([^"]+)", - \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?, - \s*(-?\w+)\s*\)/xm) do #" - |type, var_name, meth_name, meth_body, param_count| - + @body.scan(%r{rb_define_ + ( + singleton_method | + method | + module_function | + private_method + ) + \(\s*(\w+), + \s*"([^"]+)", + \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?, + \s*(-?\w+)\s*\) + (?:;\s*//\s+in\s+(\w+?\.[cy]))? + }xm) do + |type, var_name, meth_name, meth_body, param_count, source_file| + #" next if meth_name == "initialize_copy" - - handle_method(type, var_name, meth_name, meth_body, param_count) + next if var_name == "ruby_top_self" + + var_name = "rb_cObject" if var_name == "rb_mKernel" + handle_method(type, var_name, meth_name, + meth_body, param_count, source_file) end - @body.scan(/rb_define_global_function\( + @body.scan(%r{rb_define_global_function\( \s*"([^"]+)", \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?, - \s*(-?\w+)\s*\)/xm) do #" - |meth_name, meth_body, param_count| + \s*(-?\w+)\s*\) + (?:;\s*//\s+in\s+(\w+?\.[cy]))? + }xm) do #" + |meth_name, meth_body, param_count, source_file| - handle_method("method", "rb_mKernel", meth_name, meth_body, param_count) + handle_method("method", "rb_mKernel", meth_name, + meth_body, param_count, source_file) end @body.scan(/define_filetest_function\( @@ -278,7 +294,9 @@ module RDoc ############################################################ - def handle_method(type, var_name, meth_name, meth_body, param_count) + def handle_method(type, var_name, meth_name, + meth_body, param_count, source_file = nil) + class_name = @known_classes[var_name] || var_name class_obj = find_class(var_name, class_name) @@ -301,8 +319,13 @@ module RDoc (1..p_count).map{|i| "p#{i}"}.join(", ") + ")" end - - find_body(meth_body, meth_obj) + + if source_file + body = (@@known_bodies[source_file] ||= File.read(source_file)) + else + body = @body + end + find_body(meth_body, meth_obj, body) class_obj.add_method(meth_obj) end end @@ -310,8 +333,8 @@ module RDoc ############################################################ # Find the C code corresponding to a c method - def find_body(meth_name, meth_obj) - if @body =~ %r{((?>/\*.*?\*/\s+))(static\s+)?VALUE\s+#{meth_name} + def find_body(meth_name, meth_obj, body) + if body =~ %r{((?>/\*.*?\*/\s+))(static\s+)?VALUE\s+#{meth_name} \s*(\(.*?\)).*?^}xm comment, params = $1, $3 body_text = $& @@ -319,7 +342,7 @@ module RDoc # see if we can find the whole body re = Regexp.escape(body_text) + "[^(]*^{.*?^}" - if Regexp.new(re, Regexp::MULTILINE).match(@body) + if Regexp.new(re, Regexp::MULTILINE).match(body) body_text = $& end diff --git a/lib/rdoc/ri/ri_formatter.rb b/lib/rdoc/ri/ri_formatter.rb index 630e475a54..f41a815435 100644 --- a/lib/rdoc/ri/ri_formatter.rb +++ b/lib/rdoc/ri/ri_formatter.rb @@ -171,7 +171,7 @@ module RI draw_line else - fail "xxUnknown flow element: #{item.class}" + fail "Unknown flow element: #{item.class}" end end |