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.
From Command Line
apm install api-notation
Open the Package Manager from Palette Manager
⌘⇧Pon OSX or
⌃⇧Pon Windows/Linux to open the palette manager
- Look for
Install Packages and Themes
Open the Package Manager from Preferences
- Go to
Atom -> Preferencesmenu
- Go to
- Search for
api-notationin the search bar
- Click Install
.api file, or set it as your syntax.
API Notation Reference
The most recent reference as of now is in this gist, 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?