malys
5/7/2014 - 6:10 AM

JSDoc Snippets for Brackets

JSDoc Snippets for Brackets

[
   {
      "name":"JsDoc Author",
      "trigger":"@a",
      "usage":"@author userName",
      "description":"Indicates the author of the code",
      "template":"@author  $${name}\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Constructor",
      "trigger":"@c",
      "usage":"@constructor",
      "description":"Constructor",
      "template":"@constructor\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Deprecated",
      "trigger":"@d",
      "usage":"@deprecated description",
      "description":"Indicates the author of the code",
      "template":"@deprecated $${description}\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Enum",
      "trigger":"@e",
      "usage":"@enum",
      "description":"Variables that contain a JavaScript Object with key/value pairs",
      "template":"/**\n * @enum\n */!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Example",
      "trigger":"@ex",
      "usage":"@example",
      "description":"Tag allowing to provide some sample ",
      "template":"@example\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Override",
      "trigger":"@o",
      "usage":"@override",
      "description":"Tag to describe that the function is overriding an equally named function on a super form",
      "template":"@override\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Param",
      "trigger":"@p",
      "usage":"@param {Type} name parameterDescription",
      "description":"Describe function parameters. ",
      "template":"@param  {$${type}} $${name}\n$${description}!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Public",
      "trigger":"@pu",
      "usage":"@public",
      "description":"public function or variabl",
      "template":"@public\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Private",
      "trigger":"@pri",
      "usage":"@private",
      "description":"private function or variabl",
      "template":"@private\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Protected",
      "trigger":"@pro",
      "usage":"@protected",
      "description":"protected function or variabl",
      "template":"@protected\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Return",
      "trigger":"@r",
      "usage":"@return {Type}",
      "description":"Annotates the type of the returned value. ",
      "template":"@return  {$${type}}\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc See",
      "trigger":"@see",
      "usage":"@see seeDescription",
      "description":"Tag to provide pointers to other parts of the code that are related",
      "template":"@see  $${description}\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc This",
      "trigger":"@th",
      "usage":"@this {Type}",
      "description":"Tag to specify the type of the this object inside functions.",
      "template":"@this  {$${type}}\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Throws",
      "trigger":"@thr",
      "usage":"@throws {Type}",
      "description":"Tag to describe the type of Exceptions that can be raised when the function is called",
      "template":"@throws  {$${type}}\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Type",
      "trigger":"@t",
      "usage":"@type {Type}",
      "description":"Tag to specify the type of the value that a variable can hold",
      "template":"@type  {$${type}}\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Typedef",
      "trigger":"@td",
      "usage":"@typedef {Type}",
      "description":"Variables tagged using the @typedef JSDoc tag are considered definitions of types.",
      "template":"@typedef  $${type}\n!!{cursor}",
      "inline":true
   },
   {
      "name":"JsDoc Version",
      "trigger":"@v",
      "usage":"@version versionDescription",
      "description":"Tag to provide information about the version of the code",
      "template":"@version  $${description}\n!!{cursor}",
      "inline":true
   }
]