feat: add links in comments (#240)

go-kod · Sep 9, 2024 · 404c76b · 404c76b
1 parent b2d7fee
commit 404c76b
Show file tree

Hide file tree

Showing 16 changed files with 76 additions and 32 deletions.
diff --git a/cmd/kod/internal/generate_generator.go b/cmd/kod/internal/generate_generator.go
@@ -740,13 +740,14 @@ func (g *generator) generateLocalStubs(p printFn) {
 	p(``)
 	p(``)
 	p(`// Local stub implementations.`)
+	p(``)
 	g.tset.importPackage("context", "context")
 
 	var b strings.Builder
 	for _, comp := range g.components {
 
 		stub := notExported(comp.intfName()) + "_local_stub"
-		p(``)
+		p(`// %s is a local stub implementation of [%s].`, stub, g.tset.genTypeString(comp.intf))
 		p(`type %s struct{`, stub)
 		p(`	impl %s`, g.componentRef(comp))
 		p(`	name   string`)

diff --git a/cmd/kod/internal/struct2interface.go b/cmd/kod/internal/struct2interface.go
@@ -296,9 +296,12 @@ func makeFile(file string) (*makeInterfaceFile, error) {
 		}
 	}
 
+	for _, structName := range structInfo.structs {
+		typeDoc[structName] = fmt.Sprintf("%s is a component interface implemented by [%s].\n%s",
+			structInfo.struct2Interfaces[structName], structName, structInfo.typeDoc[structName])
+	}
+
 	for structName, methods := range structInfo.methods {
-		typeDoc[structName] = fmt.Sprintf("%s is a component that implements %s.\n%s",
-			structName, structInfo.struct2Interfaces[structName], structInfo.typeDoc[structName])
 		for _, m := range methods {
 			allMethods[structName] = append(allMethods[structName], m.Lines()...)
 		}

diff --git a/examples/helloworld/kod_gen.go b/examples/helloworld/kod_gen.go
diff --git a/examples/helloworld/kod_gen_interface.go b/examples/helloworld/kod_gen_interface.go
diff --git a/tests/case1/kod_gen.go b/tests/case1/kod_gen.go
diff --git a/tests/case1/kod_gen_interface.go b/tests/case1/kod_gen_interface.go
diff --git a/tests/case2/kod_gen.go b/tests/case2/kod_gen.go
diff --git a/tests/case2/kod_gen_interface.go b/tests/case2/kod_gen_interface.go
diff --git a/tests/case3/kod_gen.go b/tests/case3/kod_gen.go
diff --git a/tests/case3/kod_gen_interface.go b/tests/case3/kod_gen_interface.go