decode 0.20.0 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 742b2c4908ded7f357fdba5f4a65da4714720307a86dcce2ef6d7da2fbb3e8ec
-  data.tar.gz: 5c4f90dc81fc5706afb3b55c530c88fa520705a26d1998e7dec76349bb039653
+  metadata.gz: cad37ec3456d7b6edc9bcfa36c28b4f05c83ba978fed9a1989d0c0daba8b12c9
+  data.tar.gz: 559c5b61c73b58f420591361502c76f81e168c74e1c425dfcb2a89bf4766c9d9
 SHA512:
-  metadata.gz: c8b3aaf6638b577b4efe790adac6689a0825afcb70644f8ae9d15990281bdc4d60bf052f46ed1fca548ec645edd573b94d35dd56b1b94528abbbab46f059bd9b
-  data.tar.gz: b9c6efcc4f6817924c95042c8c03b4fb6a040a5fc98e77d94cd19efa7d3c069ad7667c73bf1237196058f0c7b7ad7de6bf34a4ffcac20309bfdf610573987a91
+  metadata.gz: b1e7915cb517d46bc9372734244045bffe3bd32acaae6bd7cb3f4dd7eaef9240faf74b63bff4249a7d7fc7a7ab2623aff4178d41eb0a4875f735fcd724ff6fd2
+  data.tar.gz: a79d14e85375ecf5a7aa3a961ee42033bb3381b9f057472a7126b2dbde8be2cf2fd3d2eab0bd55a371e03f3085f2ed6bf3525c0b047284dd996a6b68c8756a20

data/bake/decode/index.rb

@@ -52,3 +52,26 @@ def symbols(root)
 		descend.call
 	end
 end
+
+# Print documentation for all definitions.
+# @parameter root [String] The root path to index.
+def documentation(root)
+	require 'build/files/glob'
+	require 'decode/index'
+	
+	paths = Build::Files::Path.expand(root).glob("**/*")
+	
+	index = Decode::Index.new
+	index.update(paths)
+	
+	index.definitions.each do |name, definition|
+		comments = definition.comments
+		
+		if comments
+			puts "## `#{name}`"
+			puts
+			puts comments
+			puts
+		end
+	end
+end

data/lib/decode/comment/node.rb

@@ -47,7 +47,7 @@ module Decode
 				end
 			end
 			
-			# Any lines of text associated wtih this node.
+			# Any lines of text associated with this node.
 			# @returns [Array(String) | Nil] The lines of text.
 			def text
 				if text = self.extract_text
@@ -55,8 +55,7 @@ module Decode
 				end
 			end
 			
-			# Traverse the tags from this node using {each}.
-			# Invoke `descend.call(child)` to recursively traverse the specified child.
+			# Traverse the tags from this node using {each}. Invoke `descend.call(child)` to recursively traverse the specified child.
 			#
 			# @yields {|node, descend| descend.call}
 			# 	@parameter node [Node] The current node which is being traversed.

data/lib/decode/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2020-2022, by Samuel Williams.
 
 module Decode
-	VERSION = "0.20.0"
+	VERSION = "0.20.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.20.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-06-04 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Code analysis for documentation generation.