[前][次][番号順一覧][スレッド一覧]

ruby-changes:54491

From: nobu <ko1@a...>
Date: Fri, 4 Jan 2019 18:41:17 +0900 (JST)
Subject: [ruby-changes:54491] nobu:r66706 (trunk): [DOC] mark function names [ci skip]

nobu	2019-01-04 18:41:13 +0900 (Fri, 04 Jan 2019)

  New Revision: 66706

  https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=66706

  Log:
    [DOC] mark function names [ci skip]

  Modified files:
    trunk/lib/rdoc/parser/c.rb
Index: lib/rdoc/parser/c.rb
===================================================================
--- lib/rdoc/parser/c.rb	(revision 66705)
+++ lib/rdoc/parser/c.rb	(revision 66706)
@@ -3,15 +3,15 @@ require 'tsort' https://github.com/ruby/ruby/blob/trunk/lib/rdoc/parser/c.rb#L3
 
 ##
 # RDoc::Parser::C attempts to parse C extension files.  It looks for
-# the standard patterns that you find in extensions: <tt>rb_define_class</tt>,
-# <tt>rb_define_method</tt> and so on.  It tries to find the corresponding
+# the standard patterns that you find in extensions: +rb_define_class+,
+# +rb_define_method+ and so on.  It tries to find the corresponding
 # C source for the methods and extract comments, but if we fail
 # we don't worry too much.
 #
 # The comments associated with a Ruby method are extracted from the C
 # comment block associated with the routine that _implements_ that
 # method, that is to say the method whose name is given in the
-# <tt>rb_define_method</tt> call. For example, you might write:
+# +rb_define_method+ call. For example, you might write:
 #
 #   /*
 #    * Returns a new array that is a one-dimensional flattening of this
@@ -24,8 +24,7 @@ require 'tsort' https://github.com/ruby/ruby/blob/trunk/lib/rdoc/parser/c.rb#L24
 #    *    a.flatten                 #=> [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
 #    */
 #    static VALUE
-#    rb_ary_flatten(ary)
-#        VALUE ary;
+#    rb_ary_flatten(VALUE ary)
 #    {
 #        ary = rb_obj_dup(ary);
 #        rb_ary_flatten_bang(ary);
@@ -35,16 +34,16 @@ require 'tsort' https://github.com/ruby/ruby/blob/trunk/lib/rdoc/parser/c.rb#L34
 #    ...
 #
 #    void
-#    Init_Array()
+#    Init_Array(void)
 #    {
 #      ...
 #      rb_define_method(rb_cArray, "flatten", rb_ary_flatten, 0);
 #
-# Here RDoc will determine from the rb_define_method line that there's a
+# Here RDoc will determine from the +rb_define_method+ line that there's a
 # method called "flatten" in class Array, and will look for the implementation
-# in the method rb_ary_flatten. It will then use the comment from that
+# in the method +rb_ary_flatten+. It will then use the comment from that
 # method in the HTML output. This method must be in the same source file
-# as the rb_define_method.
+# as the +rb_define_method+.
 #
 # The comment blocks may include special directives:
 #

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]