├── Snippets ├── Comment.tmSnippet ├── @ignore.tmSnippet ├── @private.tmSnippet ├── @base.tmSnippet ├── @author.tmSnippet ├── @depricated.tmSnippet ├── @extends.tmSnippet ├── @throws.tmSnippet ├── Constructor.tmSnippet ├── @see.tmSnippet ├── {@link}.tmSnippet ├── @requires.tmSnippet ├── @param.tmSnippet ├── @returns.tmSnippet ├── Class.tmSnippet └── Method.tmSnippet ├── comments.markdown ├── Commands └── Tag Reference.tmCommand ├── README.mdown └── info.plist /Snippets/Comment.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | /** 7 | 8 | */ 9 | name 10 | Comment 11 | scope 12 | source.js 13 | tabTrigger 14 | /* 15 | uuid 16 | D09914A2-E6D8-48F0-8B03-AE34531B3BB2 17 | 18 | 19 | -------------------------------------------------------------------------------- /Snippets/@ignore.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | * @ignore 7 | name 8 | @ignore 9 | scope 10 | source.js comment.block.documentation 11 | tabTrigger 12 | ign 13 | uuid 14 | B2DDA29F-AC4B-4284-AD17-6D889CE5BAA0 15 | 16 | 17 | -------------------------------------------------------------------------------- /Snippets/@private.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | * @private 7 | name 8 | @private 9 | scope 10 | source.js comment.block.documentation 11 | tabTrigger 12 | pri 13 | uuid 14 | 8434FCB6-A058-48AA-AD6B-53187C56A4B3 15 | 16 | 17 | -------------------------------------------------------------------------------- /Snippets/@base.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | * @base ${1:className} 7 | name 8 | @base 9 | scope 10 | source.js comment.block.documentation 11 | tabTrigger 12 | bas 13 | uuid 14 | 16AFC818-7260-41B0-8229-82BA9EA41587 15 | 16 | 17 | -------------------------------------------------------------------------------- /Snippets/@author.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | * @author ${1:$USER} 7 | name 8 | @author 9 | scope 10 | source.js comment.block.documentation 11 | tabTrigger 12 | aut 13 | uuid 14 | 952177DE-4C34-4DC6-A0F6-DB3D3EE9FF52 15 | 16 | 17 | -------------------------------------------------------------------------------- /Snippets/@depricated.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | * @depricated 7 | name 8 | @depricated 9 | scope 10 | source.js comment.block.documentation 11 | tabTrigger 12 | dep 13 | uuid 14 | C4D294C3-F4F0-4B50-9518-91BB6559AE03 15 | 16 | 17 | -------------------------------------------------------------------------------- /Snippets/@extends.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | * @extends ${1:className} 7 | name 8 | @extends 9 | scope 10 | source.js comment.block.documentation 11 | tabTrigger 12 | ext 13 | uuid 14 | 1537A210-A2C2-4AC7-B860-F0E8503971DE 15 | 16 | 17 | -------------------------------------------------------------------------------- /Snippets/@throws.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | * @throws ${1:ExceptionType} 7 | name 8 | @throws 9 | scope 10 | source.js comment.block.documentation 11 | tabTrigger 12 | thr 13 | uuid 14 | 0B1C0D95-8034-4C50-98A7-69C6B73E4241 15 | 16 | 17 | -------------------------------------------------------------------------------- /Snippets/Constructor.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | /** 7 | * @constructor 8 | */ 9 | 10 | name 11 | Constructor 12 | scope 13 | source.js 14 | tabTrigger 15 | /* 16 | uuid 17 | CA27D8BE-5F99-4A62-A5BC-AF10A817F536 18 | 19 | 20 | -------------------------------------------------------------------------------- /Snippets/@see.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | * @see ${1:className}${2:#methodName} 7 | name 8 | @see 9 | scope 10 | source.js comment.block.documentation 11 | tabTrigger 12 | see 13 | uuid 14 | 1C7E9B9E-CC1E-4EEB-80CE-87A6B221FA47 15 | 16 | 17 | -------------------------------------------------------------------------------- /Snippets/{@link}.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | {@link ${1:Class}${2:#Method}} 7 | name 8 | {@link} 9 | scope 10 | source.js comment.block.documentation 11 | tabTrigger 12 | link 13 | uuid 14 | 9C958AD2-120D-4929-BC1D-CAAC3D500D51 15 | 16 | 17 | -------------------------------------------------------------------------------- /Snippets/@requires.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | * @requires ${1:RequiredClassName} 7 | name 8 | @requires 9 | scope 10 | source.js comment.block.documentation 11 | tabTrigger 12 | req 13 | uuid 14 | 72F1AE56-8C22-43F2-82C8-92AC817C7D62 15 | 16 | 17 | -------------------------------------------------------------------------------- /Snippets/@param.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | * @param {${1:String|Object|Array|Boolean|Number}} ${2:paramName} ${3:Describe this parameter} 7 | name 8 | @param 9 | scope 10 | source.js comment.block.documentation 11 | tabTrigger 12 | par 13 | uuid 14 | E0C1A472-7983-4D9B-AFB2-F8E9A1E7EC16 15 | 16 | 17 | -------------------------------------------------------------------------------- /Snippets/@returns.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | * @returns ${1:Describe what it returns} 7 | ${2: * @type ${3:String|Object|Array|Boolean|Number}} 8 | name 9 | @returns 10 | scope 11 | source.js comment.block.documentation 12 | tabTrigger 13 | ret 14 | uuid 15 | E3749A12-1F4C-4A68-B7B0-D03552A3E33F 16 | 17 | 18 | -------------------------------------------------------------------------------- /comments.markdown: -------------------------------------------------------------------------------- 1 | # JavaScript JSDoc Bundle Comments 2 | 3 | Can we get a general show of hands on how widely used JSDoc is, and if it's the only doc system for JavaScript? If it is we might want to consider just moving this into the main JavaScript bundle? 4 | 5 | * Unsure of tab trigger of /* might it be trigger by accident as people align comments? Would /** change that, or is it not an issue? 6 | * The "Comment" snippet seems misnamed, it should be Doc Comment or similar. Or seeing as we have a block comment shortcut (⌘⌥/) we could either make it that a second press of the shortcut would convert the current comment block into a doc comment block, or make a second shortcut. 7 | -------------------------------------------------------------------------------- /Snippets/Class.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | /** 7 | * ${1:Descibe this class} 8 | * @author ${2:$USER} 9 | * @version ${3:\$Rev\$} 10 | ${4: * @requires ${5:OtherClassName} 11 | } */ 12 | 13 | name 14 | Class 15 | scope 16 | source.js 17 | tabTrigger 18 | /* 19 | uuid 20 | 6446FA52-0EBC-4DE8-842B-D52F5BD1F5B7 21 | 22 | 23 | -------------------------------------------------------------------------------- /Snippets/Method.tmSnippet: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | content 6 | /** 7 | * ${1:Describe what this method does} 8 | ${2: * @private 9 | }${3: * @param {${4:String|Object|Array|Boolean|Number}\} ${5:paramName} ${6:Describe this parameter}${7} 10 | } * @returns ${8:Describe what it returns} 11 | * @type ${9:String|Object|Array|Boolean|Number} 12 | */ 13 | 14 | name 15 | Method 16 | scope 17 | source.js 18 | tabTrigger 19 | /* 20 | uuid 21 | 17F51DD9-6CB7-4174-91E2-00E423A2190A 22 | 23 | 24 | -------------------------------------------------------------------------------- /Commands/Tag Reference.tmCommand: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | beforeRunningCommand 6 | nop 7 | command 8 | #!/bin/bash 9 | 10 | echo "<meta http-equiv='Refresh' content='0;URL=http://usejsdoc.org/#block-tags'>" 11 | input 12 | none 13 | inputFormat 14 | text 15 | keyEquivalent 16 | ^h 17 | name 18 | Tag Reference 19 | outputCaret 20 | afterOutput 21 | outputFormat 22 | html 23 | outputLocation 24 | newWindow 25 | scope 26 | source.js comment.block 27 | uuid 28 | DF0329A2-993B-4366-B055-3161E1799FEA 29 | version 30 | 2 31 | 32 | 33 | -------------------------------------------------------------------------------- /README.mdown: -------------------------------------------------------------------------------- 1 | # Installation 2 | 3 | You can install this bundle in TextMate by opening the preferences and going to the bundles tab. After installation it will be automatically updated for you. 4 | 5 | # General 6 | 7 | * [Bundle Styleguide](http://kb.textmate.org/bundle_styleguide) — _before you make changes_ 8 | * [Commit Styleguide](http://kb.textmate.org/commit_styleguide) — _before you send a pull request_ 9 | * [Writing Bug Reports](http://kb.textmate.org/writing_bug_reports) — _before you report an issue_ 10 | 11 | # License 12 | 13 | If not otherwise specified (see below), files in this repository fall under the following license: 14 | 15 | Permission to copy, use, modify, sell and distribute this 16 | software is granted. This software is provided "as is" without 17 | express or implied warranty, and with no claim as to its 18 | suitability for any purpose. 19 | 20 | An exception is made for files in readable text which contain their own license information, or files where an accompanying file exists (in the same directory) with a “-license” suffix added to the base-name name of the original file, and an extension of txt, html, or similar. For example “tidy” is accompanied by “tidy-license.txt”. -------------------------------------------------------------------------------- /info.plist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | contactEmailRot13 6 | poraargg@fpurzngvp.pbz 7 | contactName 8 | Champ Bennett 9 | description 10 | Documentation generator for JavaScript code. 11 | mainMenu 12 | 13 | items 14 | 15 | D09914A2-E6D8-48F0-8B03-AE34531B3BB2 16 | 6446FA52-0EBC-4DE8-842B-D52F5BD1F5B7 17 | CA27D8BE-5F99-4A62-A5BC-AF10A817F536 18 | 17F51DD9-6CB7-4174-91E2-00E423A2190A 19 | ------------------------------------ 20 | 38D9260D-83B4-465D-8941-A6D2C06B5E38 21 | ------------------------------------ 22 | DF0329A2-993B-4366-B055-3161E1799FEA 23 | 24 | submenus 25 | 26 | 38D9260D-83B4-465D-8941-A6D2C06B5E38 27 | 28 | items 29 | 30 | E0C1A472-7983-4D9B-AFB2-F8E9A1E7EC16 31 | E3749A12-1F4C-4A68-B7B0-D03552A3E33F 32 | 952177DE-4C34-4DC6-A0F6-DB3D3EE9FF52 33 | 8434FCB6-A058-48AA-AD6B-53187C56A4B3 34 | 1537A210-A2C2-4AC7-B860-F0E8503971DE 35 | 16AFC818-7260-41B0-8229-82BA9EA41587 36 | 72F1AE56-8C22-43F2-82C8-92AC817C7D62 37 | B2DDA29F-AC4B-4284-AD17-6D889CE5BAA0 38 | 1C7E9B9E-CC1E-4EEB-80CE-87A6B221FA47 39 | 0B1C0D95-8034-4C50-98A7-69C6B73E4241 40 | C4D294C3-F4F0-4B50-9518-91BB6559AE03 41 | 9C958AD2-120D-4929-BC1D-CAAC3D500D51 42 | 43 | name 44 | Tags 45 | 46 | 47 | 48 | name 49 | JavaScript JSDoc 50 | uuid 51 | 6FFB94A1-EB29-4A7B-87B7-7E47035CEB79 52 | 53 | 54 | --------------------------------------------------------------------------------