go/gopls/doc
Heschi Kreinick 82fe25c375 gopls/doc: improve enum value documentation
Add a new field to the options JSON, EnumValues. Use it to automatically
generate the documentation for enums. Fix the displayed type to be
"enum" rather than the full-qualified Go type name.

To make this easy, I changed the various enum constants to be strings,
with values matching their configuration values. It may be possible to
automatically parse them in the future, but we can get to that later.

The documentation for hoverKind's private values is a little janky. I
didn't want to build a way to hide them. We can hardcode it if we really
care.

Updates golang/go#33544.

Change-Id: Ia5cc958e347d5ff041068c57726d530809bb0f70
Reviewed-on: https://go-review.googlesource.com/c/tools/+/256358
Trust: Heschi Kreinick <heschi@google.com>
Run-TryBot: Heschi Kreinick <heschi@google.com>
gopls-CI: kokoro <noreply+kokoro@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-09-22 17:32:57 +00:00
..
acme.md cmd/gopls: add documentation 2019-08-27 15:23:08 +00:00
analyzers.md gopls/doc: fix composites analyzer name 2020-06-12 18:47:36 +00:00
atom.md gopls/doc: add documentation for gopls with Atom 2019-11-27 06:49:51 +00:00
command-line.md gopls/doc: add and make minor changes to documentation 2019-09-16 01:38:12 +00:00
contributing.md gopls/doc: add and make minor changes to documentation 2019-09-16 01:38:12 +00:00
daemon.md internal/lsp/lsprpc: improvements to daemon logging 2020-07-16 19:33:22 +00:00
design.md gopls/doc: minor fixes in design.md and implementation.md 2020-01-14 23:33:23 +00:00
emacs.md gopls/doc: remove company-lsp from emacs.md 2020-05-11 23:25:44 +00:00
faq.md cmd/gopls: add documentation 2019-08-27 15:23:08 +00:00
generate.go gopls/doc: improve enum value documentation 2020-09-22 17:32:57 +00:00
generate_test.go gopls/doc: generate settings JSON, docs 2020-09-09 20:53:33 +00:00
implementation.md gopls/doc: minor fixes in design.md and implementation.md 2020-01-14 23:33:23 +00:00
integrating.md all: fix broken links to LSP specification 2019-10-02 18:32:53 +00:00
settings.md gopls/doc: improve enum value documentation 2020-09-22 17:32:57 +00:00
status.md gopls/doc: Clear out fixed issues 2020-02-24 23:14:51 +00:00
subl.md cmd/gopls: add documentation 2019-08-27 15:23:08 +00:00
troubleshooting.md gopls/doc: add memory usage info to troubleshooting guide 2020-09-08 20:42:16 +00:00
user.md x/gools/gopls: document settings for working on source distribution 2020-09-10 14:38:07 +00:00
vim.md gopls/docs: adding nvim-lsp option in gopls README file 2020-04-07 19:18:07 +00:00
vscode.md gopls/doc: update vscode-go GitHub link 2020-06-12 15:25:27 +00:00