Class: Decode::Documentation

Inherits:

Comment::Node

• Object
• Comment::Node
• Decode::Documentation

Defined in:

lib/decode/documentation.rb

Overview

Structured access to a set of comment lines.

Instance Attribute Summary

• #comments ⇒ Object readonly

  The underlying comments from which the documentation is extracted.

• #language ⇒ Object readonly

  The language in which the documentation was extracted from.

Attributes inherited from Comment::Node

#children

Instance Method Summary

• #initialize(comments, language = nil) ⇒ Documentation constructor

  Initialize the documentation with an array of comments, within a specific language.

Methods inherited from Comment::Node

#add, #children?, #each, #text, #traverse

Constructor Details

#initialize(comments, language = nil) ⇒ Documentation

Initialize the documentation with an array of comments, within a specific language.

# File 'lib/decode/documentation.rb', line 38

def initialize(comments, language = nil)
	@comments = comments
	@language = language
	
	language.tags.parse(@comments.dup) do |node|
		self.add(node)
	end
end

Instance Attribute Details

#comments ⇒ Object (readonly)

The underlying comments from which the documentation is extracted.

# File 'lib/decode/documentation.rb', line 49

def comments
  @comments
end

#language ⇒ Object (readonly)

The language in which the documentation was extracted from.

# File 'lib/decode/documentation.rb', line 53

def language
  @language
end