Update comment to show call-seq example

git-svn-id: http://svn.ruby-lang.org/repos/ruby/branches/ruby_1_8@6593 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 24 insertions, 0 deletions

diff --git a/lib/rdoc/parsers/parse_c.rb b/lib/rdoc/parsers/parse_c.rb
index 203593458..31c110640 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