mirror of
https://github.com/golang/go
synced 2024-10-01 09:28:37 -06:00
9eb0fb1732
This change adds support for showing documentation when hovering over any named type or function. For now, we show the entire comment associated with the type; in future CLs, we should refine our approach and perhaps only show the first line or sentence. Updates golang/go#29151 Change-Id: Ib33284747b19acba67d79fb55c916574c3dd8073 Reviewed-on: https://go-review.googlesource.com/c/tools/+/172958 Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Ian Cottrell <iancottrell@google.com>
71 lines
1.6 KiB
Go
71 lines
1.6 KiB
Go
// Copyright 2019 The Go Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package lsp
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"golang.org/x/tools/internal/lsp/protocol"
|
|
"golang.org/x/tools/internal/lsp/source"
|
|
"golang.org/x/tools/internal/span"
|
|
)
|
|
|
|
func (s *Server) hover(ctx context.Context, params *protocol.TextDocumentPositionParams) (*protocol.Hover, error) {
|
|
uri := span.NewURI(params.TextDocument.URI)
|
|
view := s.findView(ctx, uri)
|
|
f, m, err := newColumnMap(ctx, view, uri)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
spn, err := m.PointSpan(params.Position)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
identRange, err := spn.Range(m.Converter)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
ident, err := source.Identifier(ctx, view, f, identRange.Start)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
hover, err := ident.Hover(ctx, nil, s.enhancedHover, s.preferredContentFormat == protocol.Markdown)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
identSpan, err := ident.Range.Span()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
rng, err := m.Range(identSpan)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &protocol.Hover{
|
|
Contents: protocol.MarkupContent{
|
|
Kind: s.preferredContentFormat,
|
|
Value: hover,
|
|
},
|
|
Range: &rng,
|
|
}, nil
|
|
}
|
|
|
|
func markupContent(decl, doc string, kind protocol.MarkupKind) protocol.MarkupContent {
|
|
result := protocol.MarkupContent{
|
|
Kind: kind,
|
|
}
|
|
switch kind {
|
|
case protocol.PlainText:
|
|
result.Value = decl
|
|
case protocol.Markdown:
|
|
result.Value = "```go\n" + decl + "\n```"
|
|
}
|
|
if doc != "" {
|
|
result.Value = fmt.Sprintf("%s\n%s", doc, result.Value)
|
|
}
|
|
return result
|
|
}
|