]> git.r.bdr.sh - rbdr/api-notation.vim/blob - README.md
3428fa71f632c75dadac5c0dd0759f6f98934d2b
[rbdr/api-notation.vim] / README.md
1 # API Notation Syntax for Vim
2
3 This is a syntax for api notation, a simple notation I've been using for
4 annotating module APIs in specs and other documents.
5
6 ## Installing
7
8 Install with pathogen:
9
10 1. Clone the repo or copy the files to your `.vim/bundle` dir
11 2. Reload the vim
12 3. Enjoy the vim
13
14 ## API Notation Reference
15
16 The most recent reference as of now is in this [text file][api-reference], so
17 check that to be sure. But here's a reproduction of the notation.
18
19 ```
20 NameOfClass.WithPossibleNamespace
21 + class property
22 - instance property
23 ~> listened events (socket)
24 +> listened events (class/module)
25 -> listened events (instance)
26 <~ dispatched events (socket)
27 <+ dispatched events(class/module)
28 <- dispatched events (instance)
29 :: class method
30 # instance method
31
32 Other symbols
33 => returns
34 ->() callback return
35 [xx] optional
36 <xx> data type
37
38 Recommended order: class first, then sockets, then instance. Internally:
39 Properties, events, methods.
40
41 // Anything after two forward slashes is a comment
42 ```
43
44 ## How does it look like?
45
46 Like this.
47
48 ![Like this.][api-example]
49
50 [api-reference]: https://gitlab.com/rbdr/txt/-/blob/main/reference/api_notation.md
51 [api-example]: https://i.imgur.com/OreLcmE.png