[rbdr/api-notation.vscode] / README.md

# 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 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 [gist][api-reference], 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.][api-example]

[api-reference]: https://gist.github.com/rbdr/4694c46fcec131468e34
[api-example]: https://i.imgur.com/63TyFMe.png
Commit	Line	Data
e6c2e653	1	# API Notation Syntax for Atom
45491641	2
e6c2e653 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.
	5
	6	## Installing
	7
	8	### From Command Line
	9
891e104e BB	10	`code --install-extension api-notation`
	11
	12	### From GUI
	13
	14	#### Open the Extension Manager from Palette Manager
	15
	16	1. Press `⌘⇧P` on OSX or `⌃⇧P` on Windows/Linux to open the palette manager
	17	2. Look for `Install Ext4ensions
	18
	19	#### Open the Package Manager from Preferences
	20
	21	1. Go to `Code -> Preferences -> Extensions` menu item
	22
	23	#### Install it
	24
	25	1. Search for `api-notation` in the search bar
	26	2. Click Install
	27
e6c2e653 BB	28
	29	## Usage
	30
	31	Open a `.api` file, or set it as your syntax.
	32
	33	## API Notation Reference
	34
	35	The most recent reference as of now is in this [gist][api-reference], so
	36	check that to be sure. But here's a reproduction of the notation.
	37
	38	```
	39	NameOfClass.WithPossibleNamespace
	40	+ class property
	41	- instance property
	42	~> listened events (socket)
	43	+> listened events (class/module)
	44	-> listened events (instance)
	45	<~ dispatched events (socket)
	46	<+ dispatched events(class/module)
	47	<- dispatched events (instance)
	48	:: class method
	49	# instance method
	50
	51	Other symbols
	52	=> returns
	53	->() callback return
	54	[xx] optional
	55	<xx> data type
	56
	57	Recommended order: class first, then sockets, then instance. Internally:
	58	Properties, events, methods.
	59
	60	// Anything after two forward slashes is a comment
	61	```
	62
	63	## How does it look like?
	64
	65	Like this.
	66
	67	![Like this.][api-example]
	68
	69	[api-reference]: https://gist.github.com/rbdr/4694c46fcec131468e34
	70	[api-example]: https://i.imgur.com/63TyFMe.png