]> git.r.bdr.sh - rbdr/api-notation-atom/blame - README.md
Prepare 1.0.2 release
[rbdr/api-notation-atom] / README.md
CommitLineData
c347f4b5 1# API Notation Syntax for Atom
52942a9a 2
c347f4b5
BB
3This is a grammar for api notation, a simple notation I've been using for
4annotating module APIs in specs and other documents.
52942a9a 5
c347f4b5
BB
6## Installing
7
efdd348d
BB
8### From Command Line
9
10`apm install api-notation`
11
12### From GUI
13
14#### Open the Package Manager from Palette Manager
15
161. Press `⌘⇧P` on OSX or `⌃⇧P` on Windows/Linux to open the palette manager
172. Look for `Install Packages and Themes`
18
19#### Open the Package Manager from Preferences
20
211. Go to `Atom -> Preferences` menu
3ff6002a 222. Go to `Install`
efdd348d
BB
23
24#### Install it
25
261. Search for `api-notation` in the search bar
272. Click Install
28
29## Usage
30
31Open a `.api` file, or set it as your syntax.
c347f4b5
BB
32
33## API Notation Reference
34
35The most recent reference as of now is in this [gist][api-reference], so
36check that to be sure. But here's a reproduction of the notation.
37
38```
39NameOfClass.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
51Other symbols
52 => returns
53->() callback return
54[xx] optional
55<xx> data type
56
57Recommended order: class first, then sockets, then instance. Internally:
58Properties, events, methods.
59
60// Anything after two forward slashes is a comment
61```
62
63## How does it look like?
64
65Like this.
66
67![Like this.][api-example]
68
69[api-reference]: https://gist.github.com/benbeltran/4694c46fcec131468e34
70[api-example]: https://i.imgur.com/5WXuf4u.png