git.r.bdr.sh / rbdr / api-notation-atom / blame
| Commit | Line | Data |
|---|---|---|
| c347f4b5 | 1 | # API Notation Syntax for Atom |
| 52942a9a | 2 | |
| c347f4b5 BB |
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. | |
| 52942a9a | 5 | |
| c347f4b5 BB |
6 | ## Installing |
| 7 | ||
| 8 | ?? | |
| 9 | ||
| 10 | ## API Notation Reference | |
| 11 | ||
| 12 | The most recent reference as of now is in this [gist][api-reference], so | |
| 13 | check that to be sure. But here's a reproduction of the notation. | |
| 14 | ||
| 15 | ``` | |
| 16 | NameOfClass.WithPossibleNamespace | |
| 17 | + class property | |
| 18 | - instance property | |
| 19 | ~> listened events (socket) | |
| 20 | +> listened events (class/module) | |
| 21 | -> listened events (instance) | |
| 22 | <~ dispatched events (socket) | |
| 23 | <+ dispatched events(class/module) | |
| 24 | <- dispatched events (instance) | |
| 25 | :: class method | |
| 26 | # instance method | |
| 27 | ||
| 28 | Other symbols | |
| 29 | => returns | |
| 30 | ->() callback return | |
| 31 | [xx] optional | |
| 32 | <xx> data type | |
| 33 | ||
| 34 | Recommended order: class first, then sockets, then instance. Internally: | |
| 35 | Properties, events, methods. | |
| 36 | ||
| 37 | // Anything after two forward slashes is a comment | |
| 38 | ``` | |
| 39 | ||
| 40 | ## How does it look like? | |
| 41 | ||
| 42 | Like this. | |
| 43 | ||
| 44 | ![Like this.][api-example] | |
| 45 | ||
| 46 | [api-reference]: https://gist.github.com/benbeltran/4694c46fcec131468e34 | |
| 47 | [api-example]: https://i.imgur.com/5WXuf4u.png |