From 78e06ab19423518300a2ef9478cef69468e9d4a9 Mon Sep 17 00:00:00 2001
From: drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Thu, 12 May 2011 20:17:29 +0000
Subject: 	* lib/rss/atom.rb (module RSS):  Document URIs.  Patch by Mark
 Turner. 	  [Ruby 1.9 - #4671] 	* lib/rss/rss.rb (module RSS): 
 Document exception classes.  Patch by 	  Mark Turner.  [Ruby 1.9 - #4671]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31535 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/rss/atom.rb |  8 ++++++++
 lib/rss/rss.rb  | 30 ++++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+)

(limited to 'lib/rss')

diff --git a/lib/rss/atom.rb b/lib/rss/atom.rb
index 7720f77539..f6fea386ba 100644
--- a/lib/rss/atom.rb
+++ b/lib/rss/atom.rb
@@ -2,7 +2,15 @@ require 'rss/parser'
 
 module RSS
   module Atom
+
+    ##
+    # The Atom URI W3C Namespace
+
     URI = "http://www.w3.org/2005/Atom"
+
+    ##
+    # The XHTML URI W3C Namespace
+
     XHTML_URI = "http://www.w3.org/1999/xhtml"
 
     module CommonModel
diff --git a/lib/rss/rss.rb b/lib/rss/rss.rb
index 28d8cce30d..82ab6c7cd3 100644
--- a/lib/rss/rss.rb
+++ b/lib/rss/rss.rb
@@ -70,6 +70,9 @@ module RSS
 
   class InvalidRSSError < Error; end
 
+  ##
+  # Raised if no matching tag is found.
+
   class MissingTagError < InvalidRSSError
     attr_reader :tag, :parent
     def initialize(tag, parent)
@@ -78,6 +81,9 @@ module RSS
     end
   end
 
+  ##
+  # Raised if there are more occurrences of the tag than expected.
+
   class TooMuchTagError < InvalidRSSError
     attr_reader :tag, :parent
     def initialize(tag, parent)
@@ -86,6 +92,9 @@ module RSS
     end
   end
 
+  ##
+  # Raised if a required attribute is missing.
+
   class MissingAttributeError < InvalidRSSError
     attr_reader :tag, :attribute
     def initialize(tag, attribute)
@@ -94,6 +103,9 @@ module RSS
     end
   end
 
+  ##
+  # Raised when an unknown tag is found.
+
   class UnknownTagError < InvalidRSSError
     attr_reader :tag, :uri
     def initialize(tag, uri)
@@ -102,6 +114,9 @@ module RSS
     end
   end
 
+  ##
+  # Raised when an unexpected tag is encountered.
+
   class NotExpectedTagError < InvalidRSSError
     attr_reader :tag, :uri, :parent
     def initialize(tag, uri, parent)
@@ -112,6 +127,9 @@ module RSS
   # For backward compatibility :X
   NotExceptedTagError = NotExpectedTagError
 
+  ##
+  # Raised when an incorrect value is used.
+
   class NotAvailableValueError < InvalidRSSError
     attr_reader :tag, :value, :attribute
     def initialize(tag, value, attribute=nil)
@@ -123,6 +141,9 @@ module RSS
     end
   end
 
+  ##
+  # Raised when an unknown conversion error occurs.
+
   class UnknownConversionMethodError < Error
     attr_reader :to, :from
     def initialize(to, from)
@@ -134,6 +155,9 @@ module RSS
   # for backward compatibility
   UnknownConvertMethod = UnknownConversionMethodError
 
+  ##
+  # Raised when a conversion failure occurs.
+
   class ConversionError < Error
     attr_reader :string, :to, :from
     def initialize(string, to, from)
@@ -144,6 +168,9 @@ module RSS
     end
   end
 
+  ##
+  # Raised when a required variable is not set.
+
   class NotSetError < Error
     attr_reader :name, :variables
     def initialize(name, variables)
@@ -153,6 +180,9 @@ module RSS
     end
   end
 
+  ##
+  # Raised when a RSS::Maker attempts to use an unknown maker.
+
   class UnsupportedMakerVersionError < Error
     attr_reader :version
     def initialize(version)
-- 
cgit v1.2.3