aboutsummaryrefslogtreecommitdiff
path: root/doc/haredoc.txt
blob: f33a755a5d3f5fcaea2475093d077ad4c7145079 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
*haredoc.txt* *haredoc*                                             haredoc in vim

This plugin integrates the haredoc command of the Hare programming language,
which looks up and displays documentation for Hare symbols/identifiers in your
source code, including symbols defined in the system's Hare standard library.
See haredoc(1) and hare(1).

        https://docs.harelang.org/

This plugin is not capable of resolving partial symbols (e.g. chrono::moment),
only full symbols that haredoc can resolve (e.g. time::chrono::moment).

This plugin appropriately uses |popup-window| and |terminal-window| to display
documentation. If either |+popupwin| or |+terminal| is not available, this
plugin falls back to a normal window.


MAPPINGS

                                                        *K* *haredoc-K*
K                       Show documentation for the Hare symbol under the
                        cursor in a |popup-window|.  Press q or CTRL-C to
                        close.


COMMANDS

                                                        *:Haredoc*
:Haredoc {symbol}       Show documentation for the given Hare symbol in a
                        |terminal-window|.  Press q or CTRL-C once or twice to
                        close.

:Haredoc .              Same as the |K| command.


LICENSE

Vim License


 vim:tw=78:ts=8:noet:ft=help:norl: