class Bake::Documentation

Structured access to a set of comment lines.

Constants

ATTRIBUTE
DESCRIPTION
PARAMETER

Public Class Methods

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/documentation.rb, line 14
def initialize(comments)
        @comments = comments
end

Initialize the documentation with an array of comments.

@parameter comments [Array(String)] An array of comment lines.

Public Instance Methods

attributes () { |match| ... }

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/documentation.rb, line 57
def attributes
        return to_enum(:attributes) unless block_given?
        
        @comments.each do |comment|
                if match = comment.match(ATTRIBUTE)
                        yield match
                end
        end
end

The attribute lines of the comment block. e.g. ‘@returns [String]`.

@yields {|match| …}

@parameter match [MatchData] The regular expression match with `name` and `value` keys.

@returns [Enumerable] If no block given.

description () { |""| ... }

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/documentation.rb, line 25
def description
        return to_enum(:description) unless block_given?
        
        # We track empty lines and only yield a single empty line when there is another line of text:
        gap = false
        
        @comments.each do |comment|
                if match = comment.match(DESCRIPTION)
                        if match[1]
                                if gap
                                        yield ""
                                        gap = false
                                end
                                
                                yield match[1]
                        else
                                gap = true
                        end
                else
                        break
                end
        end
end

The text-only lines of the comment block.

@yields {|match| …}

@parameter match [MatchData] The regular expression match for each line of documentation.

@returns [Enumerable] If no block given.

parameters () { |match| ... }

Source

# File vendor/bundle/ruby/3.4.0/gems/bake-0.23.1/lib/bake/documentation.rb, line 75
def parameters
        return to_enum(:parameters) unless block_given?
        
        @comments.each do |comment|
                if match = comment.match(PARAMETER)
                        yield match
                end
        end
end

The parameter lines of the comment block. e.g. ‘@parameter value [String] The value.`

@yields {|match| …}

@parameter match [MatchData] The regular expression match with `name`, `type` and `details` keys.

@returns [Enumerable] If no block given.