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

Update comment to show call-seq example

Browse source 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@6593 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
dave 2004-07-07 02:15:17 +00:00
parent e289fcf81a
commit 77e092c31c
1 changed files with 24 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

24
lib/rdoc/parsers/parse_c.rb
View file

@ -65,6 +65,30 @@
# #
# rb_define_method(....); // in: filename # rb_define_method(....); // in: filename
# #
# As an example, we might have an extension that defines multiple classes
# in its Init_xxx method. We could document them using
#
#
# /*
# * Document-class: MyClass
# *
# * Encapsulate the writing and reading of the configuration
# * file. ...
# */
#
# /*
# * Document-method: read_value
# *
# * call-seq:
# * cfg.read_value(key) -> value
# * cfg.read_value(key} { |key| } -> value
# *
# * Return the value corresponding to +key+ from the configuration.
# * In the second form, if the key isn't found, invoke the
# * block and return its value.
# */
#
# Classes and modules built in to the interpreter. We need # Classes and modules built in to the interpreter. We need
# these to define superclasses of user objects # these to define superclasses of user objects