Skip to content

Commit 6a1e4a0

Browse files
nobuaycabta
authored andcommitted
[DOC] mark function names [ci skip]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66706 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
1 parent e5afa89 commit 6a1e4a0

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

lib/rdoc/parser/c.rb

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33

44
##
55
# RDoc::Parser::C attempts to parse C extension files. It looks for
6-
# the standard patterns that you find in extensions: <tt>rb_define_class</tt>,
7-
# <tt>rb_define_method</tt> and so on. It tries to find the corresponding
6+
# the standard patterns that you find in extensions: +rb_define_class+,
7+
# +rb_define_method+ and so on. It tries to find the corresponding
88
# C source for the methods and extract comments, but if we fail
99
# we don't worry too much.
1010
#
1111
# The comments associated with a Ruby method are extracted from the C
1212
# comment block associated with the routine that _implements_ that
1313
# method, that is to say the method whose name is given in the
14-
# <tt>rb_define_method</tt> call. For example, you might write:
14+
# +rb_define_method+ call. For example, you might write:
1515
#
1616
# /*
1717
# * Returns a new array that is a one-dimensional flattening of this
@@ -24,8 +24,7 @@
2424
# * a.flatten #=> [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
2525
# */
2626
# static VALUE
27-
# rb_ary_flatten(ary)
28-
# VALUE ary;
27+
# rb_ary_flatten(VALUE ary)
2928
# {
3029
# ary = rb_obj_dup(ary);
3130
# rb_ary_flatten_bang(ary);
@@ -35,16 +34,16 @@
3534
# ...
3635
#
3736
# void
38-
# Init_Array()
37+
# Init_Array(void)
3938
# {
4039
# ...
4140
# rb_define_method(rb_cArray, "flatten", rb_ary_flatten, 0);
4241
#
43-
# Here RDoc will determine from the rb_define_method line that there's a
42+
# Here RDoc will determine from the +rb_define_method+ line that there's a
4443
# method called "flatten" in class Array, and will look for the implementation
45-
# in the method rb_ary_flatten. It will then use the comment from that
44+
# in the method +rb_ary_flatten+. It will then use the comment from that
4645
# method in the HTML output. This method must be in the same source file
47-
# as the rb_define_method.
46+
# as the +rb_define_method+.
4847
#
4948
# The comment blocks may include special directives:
5049
#

0 commit comments

Comments
 (0)