paru 0.2.4.2 → 0.2.4.3

data/lib/paru/filter/ordered_list.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,26 +17,42 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./list"
-    require_relative "./list_attributes"
+    module PandocFilter
+        require_relative "./list"
+        require_relative "./list_attributes"
 
-    # OrderedList ListAttributes [[Block]]
-    class OrderedList < List
-      attr_accessor :list_attributes
+        # An OrderedList Node 
+        # 
+        # @example In markdown an ordered list looks like
+        #   1. this is the first item
+        #   2. this the second
+        #   3. and so on
+        #
+        # It has an ListAttributes object and a list of items
+        #
+        # @!attribute list_attributes
+        #   @return [ListAttributes]
+        class OrderedList < List
+            attr_accessor :list_attributes
 
-      def initialize contents
-        @list_attributes = ListAttributes.new contents[0]
-        super contents[1]
-      end
+            # Create a new OrderedList node based on the contents
+            #
+            # @param contents [Array]
+            def initialize(contents)
+                @list_attributes = ListAttributes.new contents[0]
+                super contents[1]
+            end
 
-      def ast_contents
-        [
-          @list_attributes.to_ast,
-          super
-        ] 
-      end
+            # The AST contents
+            #
+            # @return [Array]
+            def ast_contents
+                [
+                    @list_attributes.to_ast,
+                    super
+                ] 
+            end
 
+        end
     end
-  end
 end

data/lib/paru/filter/para.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,19 +17,26 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./block"
-  
-    # Para [Inline]
-    class Para < Block
-      def initialize contents
-        super contents, true
-      end
+    module PandocFilter
+        require_relative "./block"
 
-      def has_inline?
-        true
-      end
+        # A Para is a paragraph: a list of Inline nodes
+        class Para < Block
 
+            # Create a new Para node based on the contents
+            #
+            # @param contents [Array]
+            def initialize(contents)
+                super contents, true
+            end
+
+            # Does a Para have inline content?
+            #
+            # @return [Boolean] true
+            def has_inline?
+                true
+            end
+
+        end
     end
-  end
 end

data/lib/paru/filter/plain.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,18 +17,27 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./block"
+    module PandocFilter
+        require_relative "./block"
 
-    # Plain [Inline]
-    class Plain < Block
-      def initialize contents
-        super contents, true
-      end
+        # A Plain node is a basic Block level node with Inline children. Not
+        # to be confused with Para, which represents a paragraph. A Plain
+        # is more general.
+        class Plain < Block
 
-      def has_inline?
-        true
-      end
+            # Create a new Plain node based on contents
+            #
+            # @param contents [Array]
+            def initialize(contents)
+                super contents, true
+            end
+
+            # Has a Plain node inline contents?
+            #
+            # @return [Boolean] true
+            def has_inline?
+                true
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/quoted.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,26 +17,35 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./inline"
+    module PandocFilter
+        require_relative "./inline"
 
-    # Quoted QuoteType [Inline]
-    class Quoted < Inline
-      QUOTE_TYPE = ["SingleQuote", "DoubleQuote"]
+        # A Quoted node represents a quote with a type and the contents of the
+        # quote
+        #
+        # @!attribute quote_type
+        #   @return [QUOTE_TYPE]
+        class Quoted < Inline
+            # A quote is either a single quote or a double quote
+            QUOTE_TYPE = ["SingleQuote", "DoubleQuote"]
 
-      attr_accessor :quote_type
+            attr_accessor :quote_type
 
-      def initialize contents
-        @quote_type = contents[0]
-        super contents[1]
-      end
+            # Create a new Quote node based on the contents
+            #
+            # @param contents [Array]
+            def initialize(contents)
+                @quote_type = contents[0]
+                super contents[1]
+            end
 
-      def ast_contents
-        [
-          @quote_type,
-          super
-        ]
-      end
+            # The AST contents of a Quote node
+            def ast_contents()
+                [
+                    @quote_type,
+                    super
+                ]
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/raw_block.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,27 +17,40 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./block"
+    module PandocFilter
+        require_relative "./block"
 
-    # RawBlock Format String
-    class RawBlock < Block
-      attr_accessor :format, :string
+        # A RawBlock node has a format and a string contents
+        #
+        # @!attribute format
+        #   @return [String]
+        #
+        # @!attribute string
+        #   @return [String]
+        class RawBlock < Block
+            attr_accessor :format, :string
 
-      def initialize(contents)
-        @format, @string = contents
-      end
+            # Create a new RawBlock node based on the contents
+            #
+            # @param contents [Array]
+            def initialize(contents)
+                @format, @string = contents
+            end
 
-      def to_ast
-        [
-          @format,
-          @string
-        ]
-      end
+            # Create an AST representation of this RawBlock node
+            def to_ast()
+                [
+                    @format,
+                    @string
+                ]
+            end
 
-      def has_string?
-        true
-      end
+            # Has this RawBlock node a string value?
+            #
+            # @return [Boolean] true
+            def has_string?
+                true
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/raw_inline.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,32 +17,50 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
+    module PandocFilter
 
-    require_relative "./inline"
+        require_relative "./inline"
 
-    # RawInline Format String
-    class RawInline < Inline
-      attr_accessor :format, :string
+        # A RawInline node has a format  and a string value
+        #
+        # @!attribute format
+        #   @return [String]
+        #
+        # @!attribute string
+        #   @return [String]
+        class RawInline < Inline
+            attr_accessor :format, :string
 
-      def initialize contents
-        @format, @string = contents
-      end
+            # Create a new RawInline node based on the contents
+            #
+            # @param contents [Array]
+            def initialize(contents)
+                @format, @string = contents
+            end
 
-      def ast_contents
-        [
-          @format,
-          @string
-        ]
-      end
+            # The AST contents
+            #
+            # @return [Array]
+            def ast_contents()
+                [
+                    @format,
+                    @string
+                ]
+            end
 
-      def has_string?
-        true
-      end
+            # Has this RawInline a string value?
+            #
+            # @return [Boolean] true
+            def has_string?()
+                true
+            end
 
-      def has_inline?
-        false
-      end
+            # Has this RawInline inline contents?
+            #
+            # @return [Boolean] false
+            def has_inline?()
+                false
+            end
+        end
     end
-  end
 end

data/lib/paru/filter/small_caps.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,12 +17,13 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./inline"
+    module PandocFilter
+        require_relative "./inline"
 
-    # SmallCaps [Inline]
-    class SmallCaps < Inline
+        # A SmallCaps node is an inline level node representing SMALL CAPS
+        # text
+        class SmallCaps < Inline
+        end
     end
-  end
 end
 

data/lib/paru/filter/soft_break.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,11 +17,11 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./empty_inline"
+    module PandocFilter
+        require_relative "./empty_inline"
 
-    # SoftBreak
-    class SoftBreak < EmptyInline
+        # A SoftBreak node
+        class SoftBreak < EmptyInline
+        end
     end
-  end
 end

data/lib/paru/filter/space.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,11 +17,11 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
-    require_relative "./empty_inline"
+    module PandocFilter
+        require_relative "./empty_inline"
 
-    # Space
-    class Space < EmptyInline
+        # A Space node
+        class Space < EmptyInline
+        end
     end
-  end
 end

data/lib/paru/filter/span.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,26 +17,36 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  module PandocFilter
+    module PandocFilter
 
-    require_relative "./inline"
-    require_relative "./attr"
+        require_relative "./inline"
+        require_relative "./attr"
 
-    # Span Attr [Inline]
-    class Span < Inline
-      attr_accessor :attr
+        # A Span node is a general Inline level node with attributes and
+        # contens
+        #
+        # @!attribute attr
+        #   @return [Attr]
+        class Span < Inline
+            attr_accessor :attr
 
-      def initialize contents
-        @attr = Attr.new contents[0]
-        super contents[1]
-      end
+            # Create a new Span node based on the contents
+            #
+            # @param contents [Array]
+            def initialize(contents)
+                @attr = Attr.new contents[0]
+                super contents[1]
+            end
 
-      def ast_contents
-        [
-          @attr.to_ast,
-          super
-        ]
-      end
+            # The AST contents
+            #
+            # @return [Array]
+            def ast_contents()
+                [
+                    @attr.to_ast,
+                    super
+                ]
+            end
+        end
     end
-  end
 end