clean up rdoc

jordanbrock · Feb 21, 2009 · 5703113 · 5703113
1 parent 07581bf
commit 5703113
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 7 deletions.
diff --git a/lib/campaign_monitor.rb b/lib/campaign_monitor.rb
@@ -201,7 +201,7 @@ def using_soap
   end
 
   # Encapsulates
-  class SubscriberBounce
+  class SubscriberBounce #:nodoc:
     attr_reader :email_address, :bounce_type, :list_id
 
     def initialize(email_address, list_id, bounce_type)
@@ -212,7 +212,7 @@ def initialize(email_address, list_id, bounce_type)
   end
 
   # Encapsulates
-  class SubscriberOpen
+  class SubscriberOpen #:nodoc:
     attr_reader :email_address, :list_id, :opens
 
     def initialize(email_address, list_id, opens)
@@ -223,7 +223,7 @@ def initialize(email_address, list_id, opens)
   end
 
   # Encapsulates
-  class SubscriberClick
+  class SubscriberClick #:nodoc:
     attr_reader :email_address, :list_id, :clicked_links
 
     def initialize(email_address, list_id, clicked_links)
@@ -234,7 +234,7 @@ def initialize(email_address, list_id, clicked_links)
   end
 
   # Encapsulates
-  class SubscriberUnsubscribe
+  class SubscriberUnsubscribe #:nodoc:
     attr_reader :email_address, :list_id
 
     def initialize(email_address, list_id)

diff --git a/support/class_enhancements.rb b/support/class_enhancements.rb
@@ -1,4 +1,4 @@
-class Class
+module ClassEnhancements
 
 def inherited_property(accessor, default = nil)
     instance_eval <<-RUBY, __FILE__, __LINE__ + 1
@@ -28,4 +28,8 @@ def get_#{accessor}
     # end
   end
 
+end
+
+class Class #:nodoc:
+  include ClassEnhancements
 end
diff --git a/support/faster-xml-simple/test/regression_test.rb b/support/faster-xml-simple/test/regression_test.rb
@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper'
 
-class RegressionTest < FasterXSTest
+class RegressionTest < FasterXSTest #:nodoc: all
   def test_content_nil_regressions
     expected = {"asdf"=>{"jklsemicolon"=>{}}}
     assert_equal expected, FasterXmlSimple.xml_in("<asdf><jklsemicolon /></asdf>")

diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -1,4 +1,4 @@
-class Test::Unit::TestCase
+class Test::Unit::TestCase #:nodoc: all
 
   def assert_not_empty(v)
     assert !v.nil?, "expected to not be empty, but was nil"