cmd/doc: stop showing interface methods while matching symbols

Fixes #31961

Change-Id: I9db9ecfd2f8ca7cf51df4413a6e0d66de5da7043
Reviewed-on: https://go-review.googlesource.com/c/go/+/178457
Run-TryBot: Agniva De Sarker <agniva.quicksilver@gmail.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Rob Pike <r@golang.org>

diff --git a/src/cmd/doc/doc_test.go b/src/cmd/doc/doc_test.go
index 22468db1ff84ee361049fc375e3bac9464eda5ea..bc870aca5846c8fe6eaf1c105ca26cdffa778a70 100644 (file)
--- a/src/cmd/doc/doc_test.go
+++ b/src/cmd/doc/doc_test.go
@@ -602,6 +602,19 @@ var tests = []test{
                        `Comment about exported interface`,
                },
        },
+       // Interface method at package level.
+       {
+               "interface method at package level",
+               []string{p, `ExportedMethod`},
+               []string{
+                       `func \(ExportedType\) ExportedMethod\(a int\) bool`,
+                       `Comment about exported method`,
+               },
+               []string{
+                       `Comment before exported method.*\n.*ExportedMethod\(\)` +
+                               `.*Comment on line with exported method`,
+               },
+       },
 
        // Method.
        {

diff --git a/src/cmd/doc/pkg.go b/src/cmd/doc/pkg.go
index 12b76c2ad094d9b57e7316eaff5bf1246879b427..32810bd5811d8c962231b50db1bcf2a21d6ea15e 100644 (file)
--- a/src/cmd/doc/pkg.go
+++ b/src/cmd/doc/pkg.go
@@ -914,8 +914,8 @@ func trimUnexportedFields(fields *ast.FieldList, isInterface bool) *ast.FieldLis
 }
 
 // printMethodDoc prints the docs for matches of symbol.method.
-// If symbol is empty, it prints all methods that match the name.
-// It reports whether it found any methods.
+// If symbol is empty, it prints all methods for any concrete type
+// that match the name. It reports whether it found any methods.
 func (pkg *Package) printMethodDoc(symbol, method string) bool {
        defer pkg.flush()
        types := pkg.findTypes(symbol)
@@ -937,6 +937,9 @@ func (pkg *Package) printMethodDoc(symbol, method string) bool {
                        }
                        continue
                }
+               if symbol == "" {
+                       continue
+               }
                // Type may be an interface. The go/doc package does not attach
                // an interface's methods to the doc.Type. We need to dig around.
                spec := pkg.findTypeSpec(typ.Decl, typ.Name)