Project

General

Profile

Bug #8889 ยป 0001-Nodoc-large-parts-of-rss.patch

steveklabnik (Steve Klabnik), 09/11/2013 05:18 AM

View differences:

lib/rss/0.9.rb
36 36
  # RSS 0.9 feed with one item. If we needed a second item, we'd make another
37 37
  # block with maker.items.new_item and build a second one.
38 38
  module RSS09
39
    NSPOOL = {}
40
    ELEMENTS = []
39
    NSPOOL = {} # :nodoc:
40
    ELEMENTS = [] # :nodoc:
41 41

  
42
    def self.append_features(klass)
42
    def self.append_features(klass) # :nodoc:
43 43
      super
44 44

  
45 45
      klass.install_must_call_validator('', "")
46 46
    end
47 47
  end
48 48

  
49
  class Rss < Element
49
  class Rss < Element # :nodoc: all
50 50

  
51 51
    include RSS09
52 52
    include RootElementMixin
......
184 184

  
185 185
      end
186 186

  
187
      class SkipHours < Element
187
      class SkipHours < Element # :nodoc: all
188 188
        include RSS09
189 189

  
190 190
        [
lib/rss/1.0.rb
35 35
  # RSS 1.0 feed with one item. If we needed a second item, we'd make another
36 36
  # block with maker.items.new_item and build a second one.
37 37
  module RSS10
38
    NSPOOL = {}
39
    ELEMENTS = []
38
    NSPOOL = {} # :nodoc:
39
    ELEMENTS = [] # :nodoc:
40 40

  
41
    def self.append_features(klass)
41
    def self.append_features(klass) # :nodoc:
42 42
      super
43 43

  
44 44
      klass.install_must_call_validator('', ::RSS::URI)
......
46 46

  
47 47
  end
48 48

  
49
  class RDF < Element
49
  class RDF < Element # :nodoc: all
50 50

  
51 51
    include RSS10
52 52
    include RootElementMixin
......
465 465
    BaseListener.install_get_text_element(URI, name, name)
466 466
  end
467 467

  
468
  module ListenerMixin
468
  module ListenerMixin # :nodoc: all
469 469
    private
470 470
    def initial_start_RDF(tag_name, prefix, attrs, ns)
471 471
      check_ns(tag_name, prefix, ns, RDF::URI, false)
lib/rss/2.0.rb
35 35
  # block with maker.items.new_item and build a second one.
36 36
  class Rss
37 37

  
38
    class Channel
38
    class Channel # :nodoc: all
39 39

  
40 40
      [
41 41
        ["generator"],
lib/rss/atom.rb
11 11
  # See the RSS module for examples consuming and creating feeds.
12 12
  module Atom
13 13

  
14
    ##
15
    # The Atom URI W3C Namespace
14
    URI = "http://www.w3.org/2005/Atom" # :nodoc:
16 15

  
17
    URI = "http://www.w3.org/2005/Atom"
16
    XHTML_URI = "http://www.w3.org/1999/xhtml" # :nodoc:
18 17

  
19
    ##
20
    # The XHTML URI W3C Namespace
21

  
22
    XHTML_URI = "http://www.w3.org/1999/xhtml"
23

  
24
    module CommonModel
18
    module CommonModel # :nodoc: all
25 19
      NSPOOL = {}
26 20
      ELEMENTS = []
27 21

  
......
48 42
      end
49 43
    end
50 44

  
51
    module ContentModel
45
    module ContentModel  # :nodoc: all
52 46
      module ClassMethods
53 47
        def content_type
54 48
          @content_type ||= nil
......
78 72
      end
79 73
    end
80 74

  
81
    module URIContentModel
75
    module URIContentModel  # :nodoc: all
82 76
      class  << self
83 77
        def append_features(klass)
84 78
          super
......
94 88
    # which is used to store small quantities of human-readable text
95 89
    #
96 90
    # The TextConstruct has a type attribute, e.g. text, html, xhtml
97
    module TextConstruct
91
    module TextConstruct  # :nodoc: all
98 92
      def self.append_features(klass)
99 93
        super
100 94
        klass.class_eval do
......
166 160
    # used to describe a person, corporation, or similar entity
167 161
    #
168 162
    # The PersonConstruct has a Name, Uri, and Email child elements
169
    module PersonConstruct
163
    module PersonConstruct  # :nodoc: all
170 164

  
171 165
      # Adds attributes for name, uri, and email to the +klass+
172 166
      def self.append_features(klass)
......
210 204
    # Examples:
211 205
    # * 2013-03-04T15:30:02Z
212 206
    # * 2013-03-04T10:30:02-05:00
213
    module DateConstruct
207
    module DateConstruct  # :nodoc: all
214 208
      def self.append_features(klass)
215 209
        super
216 210
        klass.class_eval do
......
225 219
      end
226 220
    end
227 221

  
228
    module DuplicateLinkChecker
222
    module DuplicateLinkChecker # :nodoc: all
229 223
      # Checks if there are duplicate links with the same type and hreflang attributes
230 224
      # that have an alternate (or empty) rel attribute
231 225
      #
......
247 241
    # Atom feed element
248 242
    #
249 243
    # A Feed has several metadata attributes in addition to a number of Entry child elements
250
    class Feed < RSS::Element
244
    class Feed < RSS::Element  # :nodoc: all
251 245
      include RootElementMixin
252 246
      include CommonModel
253 247
      include DuplicateLinkChecker
......
721 715

  
722 716
    # Defines a top-level Atom Entry element
723 717
    #
724
    class Entry < RSS::Element
718
    class Entry < RSS::Element # :nodoc: all
725 719
      include RootElementMixin
726 720
      include CommonModel
727 721
      include DuplicateLinkChecker
......
804 798
    BaseListener.install_get_text_element(Atom::URI, name, "#{name}=")
805 799
  end
806 800

  
807
  module ListenerMixin
801
  module ListenerMixin # :nodoc: all
808 802
    private
809 803
    def initial_start_feed(tag_name, prefix, attrs, ns)
810 804
      check_ns(tag_name, prefix, ns, Atom::URI, false)
811
-