From 77e092c31c933c243b85b6d228e93e5de239bde1 Mon Sep 17 00:00:00 2001 From: dave Date: Wed, 7 Jul 2004 02:15:17 +0000 Subject: Update comment to show call-seq example git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@6593 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- lib/rdoc/parsers/parse_c.rb | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/lib/rdoc/parsers/parse_c.rb b/lib/rdoc/parsers/parse_c.rb index 2035934588..31c1106406 100644 --- a/lib/rdoc/parsers/parse_c.rb +++ b/lib/rdoc/parsers/parse_c.rb @@ -65,6 +65,30 @@ # # 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 # these to define superclasses of user objects -- cgit v1.2.3