~rbdr/api-notation.vscode

API Notation Syntax Highlight Plugin for VSCode
431988f8 — Ruben Beltran del Rio a month ago
Add license
2ebac135 — Rubén Beltran del Río 11 months ago
Update README.md
55ab0586 — Ben Beltran 3 years ago
Merge branch 'release/1.0.0'

clone

read-only
https://git.sr.ht/~rbdr/api-notation.vscode
read/write
git@git.sr.ht:~rbdr/api-notation.vscode

You can also use your local clone with git send-email.

#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

#From Command Line

code --install-extension rbdr.api-notation

#From GUI

#Open the Extension Manager from Palette Manager
  1. Press ⌘⇧P on OSX or ⌃⇧P on Windows/Linux to open the palette manager
  2. Look for `Install Ext4ensions
#Open the Package Manager from Preferences
  1. Go to Code -> Preferences -> Extensions menu item
#Install it
  1. Search for api-notation in the search bar
  2. Click Install

#Usage

Open a .api file, or set it as your syntax.

#API Notation Reference

The most recent reference as of now is in this textt file, 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.