[prev in list] [next in list] [prev in thread] [next in thread] 

List:       ruby-core
Subject:    Re: YAML RDoc problem (was Re: Kernel rdoc HTML file not being created when rdoc is run on 1.8.3)
From:       "H.Yamamoto" <ocean () m2 ! ccsnet ! ne ! jp>
Date:       2005-10-29 2:44:25
Message-ID: 20051029114424.E1644F50.ocean () m2 ! ccsnet ! ne ! jp
[Download RAW message or body]


>module Foo
>  # this is bar method
>  def bar
>		
>  end
>end
>
>module Foo # :nodoc:
>  # this is baz method
>  def baz
>		
>  end
>end
>
>//////////////////
>
>I feel it's reasonable if :nodoc: prevents document generation
>in second module block only. (but I'm not familier with rdoc,
>so maybe this is functionality...)

But, maybe, is this enough for now?

Index: yaml.rb
===================================================================
RCS file: /src/ruby/lib/yaml.rb,v
retrieving revision 1.9.2.10
diff -u -w -b -p -r1.9.2.10 yaml.rb
--- yaml.rb	20 Sep 2005 09:22:01 -0000	1.9.2.10
+++ yaml.rb	29 Oct 2005 02:37:24 -0000
@@ -392,7 +392,7 @@ end
 require 'yaml/rubytypes'
 require 'yaml/types'
 
-module Kernel # :nodoc:
+module Kernel
     #
     # ryan:: You know how Kernel.p is a really convenient way to dump ruby
     #        structures?  The only downside is that it's not as legible as
@@ -422,7 +422,7 @@ module Kernel # :nodoc:
     #   name: dave
     #   state: TX
     #
-    def y( object, *objects )
+    def y( object, *objects ) # :nodoc:
         objects.unshift object
         puts( if objects.length == 1
                   YAML::dump( *objects )


[prev in list] [next in list] [prev in thread] [next in thread]