blob: 64dfd235e665da4cbee78f3fc03ecae8082726df (
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
42
43
44
45
46
47
|
# API Notation Syntax for Atom
This is a grammar for api notation, a simple notation I've been using for
annotating module APIs in specs and other documents.
## Installing
??
## API Notation Reference
The most recent reference as of now is in this [gist][api-reference], so
check that to be sure. But here's a reproduction of the notation.
```
NameOfClass.WithPossibleNamespace
+ class property
- instance property
~> listened events (socket)
+> listened events (class/module)
-> listened events (instance)
<~ dispatched events (socket)
<+ dispatched events(class/module)
<- dispatched events (instance)
:: class method
# instance method
Other symbols
=> returns
->() callback return
[xx] optional
<xx> data type
Recommended order: class first, then sockets, then instance. Internally:
Properties, events, methods.
// Anything after two forward slashes is a comment
```
## How does it look like?
Like this.
![Like this.][api-example]
[api-reference]: https://gist.github.com/benbeltran/4694c46fcec131468e34
[api-example]: https://i.imgur.com/5WXuf4u.png
|
