› Decode › Source › Decode › Documentation

`class Documentation`

Structured access to a set of comment lines.

Definitions

`def initialize(comments, language)`

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

Signature

parameter　comments　Array(String): An array of comment lines.
parameter　language　Language::Generic?: The language in which the comments were extracted.

Implementation

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

`attr :comments`

Signature

attribute　Array(String): The underlying comments from which the documentation is extracted.

`attr :language`

Signature

attribute　Language::Generic?: The language in which the documentation was extracted from.