Download Firefox: WindowsMac OS X
logo       
Google Custom Search
    AddThis Social Bookmark Button
-->

[PATCH] Module API docs not generated in 1.8.6: msg#00008

Subject: [PATCH] Module API docs not generated in 1.8.6
Running rdoc over the 1.8.6 tree skips Module. This appears to be caused by a :stopdoc: directive in lib/yaml/tag.rb

I submitted a patch for this on rubyforge.org

http://rubyforge.org/tracker/index.php?func=detail&aid=9272&group_id=426&atid=1700




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
~






James Britt




<Prev in Thread] Current Thread [Next in Thread>