Search code examples
gogodoc

Refer a different package from the godoc of a package


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.


Solution

  • 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 {