[ ruby-Patches-9272 ] [PATCH] Rdoc omitting docs for Module due to :stopdoc: directive in lib/yaml/tab.rb

Patches item #9272, was opened at 2007-03-13 19:43
You can respond by visiting: 
http://rubyforge.org/tracker/?func=detail&atid=1700&aid=9272&group_id=426

Category: Ruby1.8
Group: None
Status: Open
Resolution: None
Priority: 3
Submitted By: James  Britt (jamesgbritt)
Assigned to: Nobody (None)
Summary: [PATCH] Rdoc omitting docs for Module due to :stopdoc: directive in lib/yaml/tab.rb

Initial Comment:
Running rdoc over the source tree does not produce the doc for Module.  It appears that a :stopdoc: directive in lib/yaml/tab.rb is interfering.  This patch replaces that directive with method-level :nodoc: directives.



Index: tag.rb
===================================================================
--- tag.rb      (revision 12064)
+++ tag.rb      (working copy)
@@ -51,12 +51,11 @@
 end

 class Module
-    # :stopdoc:

     # Adds a taguri _tag_ to a class, used when dumping or loading the class
     # in YAML.  See YAML::tag_class for detailed information on typing and
     # taguris.
-    def yaml_as( tag, sc = true )
+    def yaml_as( tag, sc = true ) # :nodoc:
         verbose, $VERBOSE = $VERBOSE, nil
         class_eval <<-"end;", __FILE__, __LINE__+1
             attr_writer :taguri
@@ -80,12 +79,12 @@
     end
     # Transforms the subclass name into a name suitable for display
     # in a subclassed tag.
-    def yaml_tag_class_name
+    def yaml_tag_class_name  # :nodoc:
         self.name
     end
     # Transforms the subclass name found in the tag into a Ruby
     # constant name.
-    def yaml_tag_read_class( name )
+    def yaml_tag_read_class( name ) # :nodoc:
         name
     end
 end
~


----------------------------------------------------------------------

You can respond by visiting: 
http://rubyforge.org/tracker/?func=detail&atid=1700&aid=9272&group_id=426