decode 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3def34b952d9d52ecd46b00af1d0d6bf35c1e1356b73f0684044d374e23fcbf3
-  data.tar.gz: b95a502a185aedaa5f64c6cdaee5abd30ba0739df530cc1fa5a957b54328f261
+  metadata.gz: b10527900f968f995dfb80150dbe8773f92857f190fe5ae3981af28363473530
+  data.tar.gz: c58a678e66c1416ebc3c7a19dae19789644c937e990343ec4ea3bc565ee991a7
 SHA512:
-  metadata.gz: ebb0306d62ce7feeff715b4fb1f2b622d21ab877285c678e8a83acb08f2183c83c4bc6cf3f2ec88743006142fa9f1c8f1094812bf2fde96d1e6d2ffcdb65c133
-  data.tar.gz: 79d583ef1946a0a94010fdd8b23cf2e36433e355eb7c6efb2f72bd949784b563d89e4693b73532e8fdc6cea3bef462dc6c74f484aff0cce95d289a675aebd731
+  metadata.gz: 2a5110378a537c6ee3ddb571a9d376af274e45ddf9835b347ac538a858eea5f140610e3cd04fa2e14c9c4c2e46a75f32adc7dbd10c39ac7de438ae2955336e7c
+  data.tar.gz: fd1b0e0bbc3912cd3eedfab8bf0b0e8c2bdcda930783f08305a7de9e92f2629e0b500f727dfd92a52958b283e429636ca8a3b83f1345de98bf59257bd17fc415

data/lib/decode/comment/attribute.rb

@@ -48,14 +48,6 @@ module Decode
 			# The type of the attribute.
 			# @attribute [String]
 			attr :type
-			
-			# The details associated with the tag.
-			# @attribute [String | Nil]
-			attr :details
-			
-			def text
-				text = super
-			end
 		end
 	end
 end

data/lib/decode/comment/node.rb

@@ -63,11 +63,11 @@ module Decode
 			end
 			
 			# Traverse the tags from this node using {each}.
-			# Invoke `descend.call` to traverse the children of the current node.
+			# Invoke `descend.call(child)` to recursively traverse the specified child.
 			#
-			# @block {|node, descend| descend.call}
-			# @yield node [Node] The current node which is being traversed.
-			# @yield descend [Proc | Nil] The recursive method for traversing children.
+			# @yields {|node, descend| descend.call}
+			# 	@parameter node [Node] The current node which is being traversed.
+			# 	@parameter descend [Proc | Nil] The recursive method for traversing children.
 			def traverse(&block)
 				descend = ->(node){
 					node.traverse(&block)

data/lib/decode/comment/parameter.rb

@@ -53,10 +53,6 @@ module Decode
 			# The type of the attribute.
 			# @attribute [String]
 			attr :type
-			
-			# The details associated with the tag.
-			# @attribute [String | Nil]
-			attr :details
 		end
 	end
 end

data/lib/decode/definition.rb

@@ -44,12 +44,15 @@ module Decode
 		
 		# The symbol name.
 		# e.g. `:Decode`.
+		# @attribute [Symbol]
 		attr :name
 		
-		# The parent symbol, defining lexical scope.
+		# The parent definition, defining lexical scope.
+		# @attribute [Definition | Nil]
 		attr :parent
 		
 		# The language the symbol is defined within.
+		# @attribute [Language::Generic]
 		attr :language
 		
 		# The comment lines which directly preceeded the definition.
@@ -83,7 +86,8 @@ module Decode
 			raise ArgumentError, "Unable to convert #{self} into #{kind}!"
 		end
 		
-		# The lexical scope which is an array of lexical {Key} instances as generated by {key}.
+		# The lexical scope as an array of names.
+		# e.g. `[:Decode, :Definition]`
 		# @returns [Array]
 		def path
 			if @path

data/lib/decode/documentation.rb

@@ -49,7 +49,7 @@ module Decode
 		attr :comments
 		
 		# The language in which the documentation was extracted from.
-		# @attribute [Language]
+		# @attribute [Language::Generic]
 		attr :language
 	end
 end

data/lib/decode/language/reference.rb

@@ -45,6 +45,7 @@ module Decode
 			attr :identifier
 			
 			# The language associated with this reference.
+			# @attribute [Language::Generic]
 			attr :language
 			
 			# Whether the reference starts at the base of the lexical tree.

data/lib/decode/language/ruby/block.rb

@@ -58,7 +58,7 @@ module Decode
 				
 				def convert(kind)
 					case kind
-					when :attr
+					when :attribute
 						Attribute.new(@node, @name,
 							comments: @comments, parent: @parent, language: @language
 						)

data/lib/decode/language/ruby/method.rb

@@ -52,9 +52,15 @@ module Decode
 					end
 				end
 				
+				# The fully qualified name of the block.
+				# e.g. `::Barnyard#foo`.
+				def qualified_form
+					self.qualified_name
+				end
+				
 				def convert(kind)
 					case kind
-					when :attr
+					when :attribute
 						Attribute.new(@node, @name,
 							comments: @comments, parent: @parent, language: @language
 						)

data/lib/decode/scope.rb

@@ -23,10 +23,13 @@ require_relative 'definition'
 module Decode
 	# An abstract namespace for nesting definitions.
 	class Scope < Definition
+		# @returns [String] The name of the scope.
 		def short_form
 			@name
 		end
 		
+		# Scopes are always containers.
+		# @returns [Boolean] Always `true`.
 		def container?
 			true
 		end

data/lib/decode/segment.rb

@@ -39,7 +39,7 @@ module Decode
 		attr :comments
 		
 		# The language of the code attached to this segment.
-		# @attribute [Language]
+		# @attribute [Language::Generic]
 		attr :language
 		
 		# An interface for accsssing the documentation of the definition.

data/lib/decode/source.rb

@@ -21,20 +21,32 @@
 require_relative 'language'
 
 module Decode
+	# Represents a source file in a specific language.
 	class Source
 		def initialize(path, language)
 			@path = path
 			@language = language
 		end
 		
+		# The path of the source file.
+		# @attribute [String] A file-system path.
 		attr :path
 		
+		# The language of the source file.
+		# @attribute [Language::Generic]
 		attr :language
 		
+		# Open the source file for reading.
+		# @yields {|file| ...} The opened {File} instance.
+		# 	@parameter file [File]
 		def open(&block)
 			File.open(@path, &block)
 		end
 		
+		# Open the source file and read all definitions.
+		# @yields {|definition| ...} All definitions from the source file.
+		# 	@parameter definition [Definition]
+		# @returns [Enumerator(Definition)] If no block given.
 		def definitions(&block)
 			return to_enum(:definitions) unless block_given?
 			
@@ -43,6 +55,10 @@ module Decode
 			end
 		end
 		
+		# Open the source file and read all segments.
+		# @yields {|segment| ...} All segments from the source file.
+		# 	@parameter segment [Segment]
+		# @returns [Enumerator(Segment)] If no block given.
 		def segments(&block)
 			return to_enum(:segments) unless block_given?
 			

data/lib/decode/trie.rb

@@ -116,7 +116,7 @@ module Decode
 		end
 		
 		# Traverse the trie.
-		# See {Node:traverse} for details.
+		# See {Node#traverse} for details.
 		def traverse(path = [], &block)
 			if node = @root.lookup(path)
 				node.traverse(&block)

data/lib/decode/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Decode
-	VERSION = "0.14.0"
+	VERSION = "0.14.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Samuel Williams