class Bake::Documentation
Structured access to a set of comment lines.
def attributes
-
(Enumerable)
-
Other tags:
- Yield: -
def attributes return to_enum(:attributes) unless block_given? @comments.each do |comment| if match = comment.match(ATTRIBUTE) yield match end end end
def description
-
(Enumerable)
-
Other tags:
- Yield: -
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
def initialize(comments)
-
comments
(Array(String)
) -- An array of comment lines.
def initialize(comments) @comments = comments end
def parameters
-
(Enumerable)
-
Other tags:
- Yield: -
def parameters return to_enum(:parameters) unless block_given? @comments.each do |comment| if match = comment.match(PARAMETER) yield match end end end