This is a grammar for api notation, a simple notation I've been using for annotating module APIs in specs and other documents.
apm install api-notation
⌘⇧Pon OSX or
⌃⇧Pon Windows/Linux to open the palette manager
Install Packages and Themes
Atom -> Preferencesmenu
Install| Header One | Header Two |
api-notationin the search bar
.api file, or set it as your syntax.
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