mirror of
https://github.com/golang/go
synced 2024-11-18 15:04:44 -07:00
abbb706b23
This change removes the explicit configuration for improved documentation on hover. We use a comment's synopsis rather than the full comment. However, we also add a "noDocsOnHover" setting that is used by the cmd tests. Ultimately, no one should use this setting and we should remove it. We leave it temporarily because the cmd tests still need work. Change-Id: I5488eca96a729ed7edad8f59b95af163903740d6 Reviewed-on: https://go-review.googlesource.com/c/tools/+/174378 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 := getGoFile(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.preferredContentFormat == protocol.Markdown, !s.noDocsOnHover)
|
|
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
|
|
}
|