]> git.r.bdr.sh - rbdr/api-notation-atom/blob - README.md
da362d191e8994edc9f3a714d09a811145f8e5bf
[rbdr/api-notation-atom] / README.md
1 # API Notation Syntax for Atom
2
3 This is a grammar 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 ### From Command Line
9
10 `apm install api-notation`
11
12 ### From GUI
13
14 #### Open the Package Manager from Palette Manager
15
16 1. Press `⌘⇧P` on OSX or `⌃⇧P` on Windows/Linux to open the palette manager
17 2. Look for `Install Packages and Themes`
18
19 #### Open the Package Manager from Preferences
20
21 1. Go to `Atom -> Preferences` menu
22 2. Go to `Install`
23
24 #### Install it
25
26 1. Search for `api-notation` in the search bar
27 2. Click Install
28
29 ## Usage
30
31 Open a `.api` file, or set it as your syntax.
32
33 ## API Notation Reference
34
35 The most recent reference as of now is in this [text file][api-reference], so
36 check that to be sure. But here's a reproduction of the notation.
37
38 ```
39 NameOfClass.WithPossibleNamespace
40 + class property
41 - instance property
42 ~> listened events (socket)
43 +> listened events (class/module)
44 -> listened events (instance)
45 <~ dispatched events (socket)
46 <+ dispatched events(class/module)
47 <- dispatched events (instance)
48 :: class method
49 # instance method
50
51 Other symbols
52 => returns
53 ->() callback return
54 [xx] optional
55 <xx> data type
56
57 Recommended order: class first, then sockets, then instance. Internally:
58 Properties, events, methods.
59
60 // Anything after two forward slashes is a comment
61 ```
62
63 ## How does it look like?
64
65 Like this.
66
67 ![Like this.][api-example]
68
69 [api-reference]: https://gitlab.com/rbdr/txt/-/blob/main/reference/api_notation.md
70 [api-example]: https://i.imgur.com/5WXuf4u.png