Add QuerySelectorAll and redocumented the library. QuerySearch, QuerySelector and QuerySelectorAll still not tested and have tests to write.

Author: udan-jayanith

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
 	"cSpell.words": [
 		"autoplay",
+		"Combinators",
 		"DOCTYPEDTD",
 		"emirpasic",
 		"gohtml",

node-tree.go

@@ -205,7 +205,16 @@ func (node *Node) IsTextNode() bool {
 	return node.GetTagName() == ""
 }
 
-// Closest traverses the node tree and its parents (heading toward the root node) until it finds a node that matches the specified query.
+// Closest traverses the node tree and its parents (heading toward the root node) until it finds a node that matches the full query.
+/*
+Ex:
+query = "div .video-container #div"
+
+<div class="video-container id="div"></div>
+
+As shown elements with every described specifiers will only match.
+But this is not the case for QuerySearch, QuerySelector and QuerySelectorAll.
+*/
 // Adapted from [https://developer.mozilla.org/en-US/docs/Web/API/Element/closest](MDN Element: closest() method)
 func (node *Node) Closest(query string) *Node {
 	queryTokens := TokenizeQuery(query)

querying.go

@@ -132,6 +132,9 @@ func (node *Node) QueryAll(query string) NodeList {
 	return nodeList
 }
 
+/*
+QuerySearch tokenizes the query string and search for nodes that matches with the right most query token. After matching right most query it proceeds to match nodes parents nodes for left over tokens and then passed that node to (yield/range). QuerySearch search the whole node tree for matches unless yield get canceled or range iterator get cancel. 
+*/
 func QuerySearch(node *Node, query string) iter.Seq[*Node] {
 	return func(yield func(node *Node) bool) {
 		queryTokens := TokenizeQuery(query)
@@ -232,10 +235,22 @@ outer:
 	return i
 }
 
+//QuerySelector only returns the first node that matches with the QuerySearch.
 func (node *Node) QuerySelector(query string) *Node {
 	iter := QuerySearch(node, query)
 	for node := range iter{
 		return node
 	}
 	return nil
 }
+
+//QuerySelectorAll stores nodes passed down by QuerySearch in a nodeList and returns the nodeList.
+func (node *Node) QuerySelectorAll(query string) NodeList{
+	iter := QuerySearch(node, query)
+	nodeList := NewNodeList()
+	
+	for node := range iter{
+		nodeList.Append(node)
+	}
+	return nodeList
+}

tokenizer.go

@@ -136,7 +136,12 @@ type QueryToken struct {
 	Selector     string
 }
 
-// TokenizeQuery tokenizes the query and returns a list of QueryToken.
+ /*
+TokenizeQuery tokenizes the query and returns a list of QueryToken.
+
+query should be of only consists of class, tag and/or id. This applies to every function that accepts a parameter name query.
+query should not consists of css selectors, Combinators and separators.
+*/
 func TokenizeQuery(query string) []QueryToken {
 	slice := make([]QueryToken, 0, 1)
 	if strings.TrimSpace(query) == "" {