annotate-extension/README.md

Brackets JSDoc Annotate
=================

A brackets extension to generate JSDoc annotations for your functions.

To install, place the ```annotate``` folder inside the ```brackets/src/extensions/user``` folder.

**Compatible with Brackets Sprint10 and higher**

Usage
=====
Open a project in Brackets, place your cursor before, or on the line of a function definition, and select ```Annotate``` form the ```Edit``` menu.

Alternatively, use the keyboard shortcut `CTRL`+`Alt`+`A` on Windows, or `⌘`+`Alt`+`A` on Mac.

This will create a JSDoc like annotation according to the function signature.  It will add ```@private``` if the function starts with an underscore. It will create a ```@param``` for each parameter.
First commit 2012-06-13 16:12:30 +00:00			`Brackets JSDoc Annotate`
			`=================`

			`A brackets extension to generate JSDoc annotations for your functions.`

			To install, place the ```annotate``` folder inside the ```brackets/src/extensions/user``` folder.

Usage info and compatibility update 2012-10-07 17:58:19 +00:00			`Compatible with Brackets Sprint10 and higher`
updated for brackets sprint10 2012-06-22 10:06:39 +00:00
First commit 2012-06-13 16:12:30 +00:00			`Usage`
			`=====`
Update README.md 2012-10-07 17:57:43 +00:00			Open a project in Brackets, place your cursor before, or on the line of a function definition, and select ```Annotate``` form the ```Edit``` menu.

Added new key bindings 2013-07-19 08:15:56 +00:00			Alternatively, use the keyboard shortcut `CTRL`+`Alt`+`A` on Windows, or `⌘`+`Alt`+`A` on Mac.
First commit 2012-06-13 16:12:30 +00:00
			This will create a JSDoc like annotation according to the function signature. It will add ```@private``` if the function starts with an underscore. It will create a ```@param``` for each parameter.