Refer a different package from the godoc of a package

Question

Can someone let me know if it is possible to refer a different package from godoc of a package? For example let's say I have a package src/logger/. In src/logger/doc.go I need to refer src/config/. Something like @see in javadoc.

Is there a recommended way?

I am on Go 1.7.

Easiest examples is to look at Go's actual documentation on https://golang.org/pkg/ and browse around until you find it. Then click on the source file and look at the actual comments. — eduncan911, Sep 24 '16 at 11:27

score 4 · Answer 1 · answered Sep 24 '16 at 14:22

I am not aware that this is currently possible. E.g. https://golang.org/pkg/io/ioutil/#TempFile refers to the os package simply using *os.File. See the source code comments at https://golang.org/src/io/ioutil/tempfile.go#L40.

and writing, and returns the resulting *os.File.

score 1 · Accepted Answer · answered Jun 28 '23 at 21:23

1

As of Go 1.19's enhancements to GoDoc, this is now possible with documentation links.

// Foo returns a [os.File].
func Foo() *os.File {

answered Jun 28 '23 at 21:23

Jonathan Hall

75,165
16
143
189

Refer a different package from the godoc of a package

2 Answers2