1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

Add explicit line breaks in method signatures for ri. Fixup some comments in object.c. Support changes comments for "in xxx.c"

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@5443 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
dave 2004-01-12 03:11:25 +00:00
parent e1f3e3496b
commit a1d3a8e861
5 changed files with 39 additions and 9 deletions

View file

@ -1,3 +1,20 @@
Mon Jan 12 12:07:22 2004 Dave Thomas <dave@pragprog.com>
* lib/rdoc/parsers/parse_c.rb (RDoc::C_Parser::do_methods):
Someone changed the "// in eval.c" comments to "/*...*/" style,
so the parsing of the source file name broke.
* object.c: Remove spurious space in TrueClass documentation.
* lib/rdoc/parsers/parse_c.rb (RDoc::C_Parser::find_body): Fix
bad regexp: if the code before a documented method contained
a comment that wasn't terminated by whitespace, that comment
and all intervening code was included in the following
method's documentation.
* lib/rdoc/ri/ri_formatter.rb (RI::HtmlFormatter::break_to_newline):
HTML formats need explicit line breaks.
Mon Jan 12 02:24:07 2004 Dave Thomas <dave@pragprog.com>
* lib/rdoc/ri/ri_formatter.rb (RI::HtmlFormatter): Add HTML

View file

@ -261,11 +261,10 @@ module RDoc
\s*"([^"]+)",
\s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
\s*(-?\w+)\s*\)
(?:;\s*//\s+in\s+(\w+?\.[cy]))?
(?:;\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"
# Ignore top-object and weird struct.c dynamic stuff
next if var_name == "ruby_top_self"
@ -282,10 +281,9 @@ module RDoc
\s*"([^"]+)",
\s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
\s*(-?\w+)\s*\)
(?:;\s*//\s+in\s+(\w+?\.[cy]))?
(?:;\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, source_file)
end
@ -346,7 +344,7 @@ module RDoc
# Find the C code corresponding to a Ruby method
def find_body(meth_name, meth_obj, body)
if body =~ %r{((?>/\*.*?\*/\s+))(static\s+)?VALUE\s+#{meth_name}
if body =~ %r{((?>/\*.*?\*/\s*))(static\s+)?VALUE\s+#{meth_name}
\s*(\(.*?\)).*?^}xm
comment, params = $1, $3
body_text = $&

View file

@ -237,7 +237,10 @@ class DefaultDisplay
params = method.name + params
end
end
params.split(/\n/).each {|p| @formatter.wrap(p) }
params.split(/\n/).each do |p|
@formatter.wrap(p)
@formatter.break_to_newline
end
end
######################################################################

View file

@ -68,6 +68,15 @@ module RI
######################################################################
# called when we want to ensure a nbew 'wrap' starts on a newline
# Only needed for HtmlFormatter, because the rest do their
# own line breaking
def break_to_newline
end
######################################################################
def bold_print(txt)
print txt
end
@ -459,14 +468,13 @@ module RI
print(escape(achar.char))
end
update_attributes(curr_attr, 0) unless curr_attr.zero?
puts
end
def draw_line(label=nil)
if label != nil
bold_print(label)
end
puts("<hr /><p />")
puts("<hr>")
end
def bold_print(txt)
@ -477,6 +485,10 @@ module RI
puts("<p>")
end
def break_to_newline
puts("<br>")
end
def display_heading(text, level, indent)
level = 4 if level > 4
tag("h#{level}") { text }

View file

@ -844,7 +844,7 @@ main_to_s(obj)
/***********************************************************************
* Document-class: TrueClass
* Document-class: TrueClass
*
* The global value <code>true</code> is the only instance of class
* <code>TrueClass</code> and represents a logically true value in