API Notation Syntax for Sublime Text
This is a syntax for api notation, a simple notation I've been using for annotating module APIs in specs and other documents.
It could work for TextMate since it's a tmLanguage file. But you need to create a tmBundle and god knows what else. So for now, just Sublime. Sorry.
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?