add GoDoc

example/like_cli/main.go

@@ -128,7 +128,7 @@ func sampleWalker() error {
 	// Output:
 	// WalkerNode's methods called...
 	// 	Name   : a
-	// 	Branch : 
+	// 	Branch :
 	// 	Row    : a
 	// 	Level  : 1
 	// 	Path   : a
@@ -164,7 +164,7 @@ func sampleWalker() error {
 	// 	Path   : a/kk/t
 	// WalkerNode's methods called...
 	// 	Name   : e
-	// 	Branch : 
+	// 	Branch :
 	// 	Row    : e
 	// 	Level  : 1
 	// 	Path   : e

example/programmable/main.go

@@ -510,7 +510,7 @@ func sampleWalker() {
 	// Output:
 	// WalkerNode's methods called...
 	// 	Name   : root
-	// 	Branch : 
+	// 	Branch :
 	// 	Row    : root
 	// 	Level  : 1
 	// 	Path   : root

simple_tree_walker.go

@@ -2,6 +2,7 @@
 
 package gtree
 
+// WalkerNode is used in user-defined function that can be executed with Walk/WalkProgrammably function.
 type WalkerNode struct {
 	name   string
 	branch string
@@ -10,22 +11,27 @@ type WalkerNode struct {
 	path   string
 }
 
+// Name returns name of node in completed tree structure.
 func (wn *WalkerNode) Name() string {
 	return wn.name
 }
 
+// Branch returns branch of node in completed tree structure.
 func (wn *WalkerNode) Branch() string {
 	return wn.branch
 }
 
+// Row returns row of node in completed tree structure.
 func (wn *WalkerNode) Row() string {
 	return wn.row
 }
 
+// Level returns level of node in completed tree structure.
 func (wn *WalkerNode) Level() uint {
 	return wn.level
 }
 
+// Path returns path of node in completed tree structure.
 func (wn *WalkerNode) Path() string {
 	return wn.path
 }
@@ -50,12 +56,11 @@ func (dw *defaultWalkerSimple) walkNode(current *Node, cb func(*WalkerNode) erro
 	if !current.isRoot() {
 		row = current.branch() + " " + current.name
 	}
-
 	wn := &WalkerNode{
 		name:   current.name,
 		branch: current.branch(),
 		row:    row,
-		level: current.hierarchy,
+		level:  current.hierarchy,
 		path:   current.path(),
 	}
 	if err := cb(wn); err != nil {

tree_handler.go

@@ -24,7 +24,7 @@ func Verify(r io.Reader, options ...Option) error {
 	return initializeTree(cfg).verify(r, cfg)
 }
 
-// TODO: add doc
+// Walk executes user-defined function while traversing tree structure.
 func Walk(r io.Reader, cb func(*WalkerNode) error, options ...Option) error {
 	cfg := newConfig(options)
 	return initializeTree(cfg).walk(r, cb, cfg)

tree_handler_programmably.go

@@ -50,7 +50,8 @@ func VerifyProgrammably(root *Node, options ...Option) error {
 	return initializeTree(cfg).verifyProgrammably(root, cfg)
 }
 
-// TODO: add doc
+// WalkProgrammably executes user-defined function while traversing tree structure.
+// This function requires node generated by NewRoot function.
 func WalkProgrammably(root *Node, cb func(*WalkerNode) error, options ...Option) error {
 	if err := validateTreeRoot(root); err != nil {
 		return err