FuncDocr

by Ole Kröger for brackets >=0.20.0 
Generates JSDoc,PHPDoc annotations for your functions.
version
0.8.41
modified
2016-05-04T16:44:37.155Z
first seen
2014-08-28T08:45:11.976Z
downloads
86620
 Versions
0.8.41
2016-05-04T16:44:37.155Z
13721
0.8.40
2016-03-31T09:19:37.327Z
3609
0.8.39
2016-01-31T00:21:40.429Z
5230
0.8.38
2016-01-30T18:54:58.018Z
224
0.8.37
2016-01-23T17:02:29.711Z
1791
0.8.36
2015-12-02T19:31:01.790Z
4120
0.8.35
2015-11-18T08:58:18.723Z
2883
0.8.34
2015-11-10T20:40:43.607Z
1687
0.8.33
2015-10-22T12:54:23.744Z
2736
0.8.32
2015-10-16T11:15:01.200Z
1350
0.8.31
2015-10-13T16:12:04.696Z
1063
0.8.30
2015-09-30T17:22:06.613Z
1912
0.8.26
2015-07-03T19:18:07.221Z
5032
0.8.25
2015-07-03T17:25:02.607Z
165
0.8.24
2015-07-01T17:01:04.280Z
815
0.8.23
2015-05-25T17:58:08.462Z
3203
0.8.22
2015-05-21T19:45:01.074Z
1067
0.8.21
2015-05-13T19:53:11.081Z
1671
0.8.20
2015-05-01T12:21:23.231Z
2016
0.8.18
2015-04-02T13:47:21.428Z
3261
0.8.17
2015-04-02T13:37:42.329Z
8
0.8.15
2015-03-31T14:16:14.362Z
973
0.8.13
2015-03-23T18:25:25.011Z
1433
0.8.12
2015-03-10T14:34:25.195Z
1948
0.8.10
2015-03-04T22:01:09.791Z
1513
0.8.9
2015-02-26T17:06:27.670Z
1493
0.8.8
2015-02-24T15:30:23.640Z
829
0.8.7
2015-02-23T13:22:36.270Z
592
0.8.5
2015-01-26T12:22:53.459Z
2261
0.8.4
2015-01-24T19:23:27.470Z
700
0.8.2
2015-01-14T20:48:54.289Z
1249
0.8.1
2015-01-07T18:53:21.852Z
1161
0.8.0
2015-01-04T18:38:49.777Z
876
0.7.1
2014-12-31T16:15:02.529Z
685
0.7.0
2014-12-15T08:11:40.208Z
1479
0.6.1
2014-11-27T12:50:39.768Z
1696
0.6.0
2014-11-17T15:48:07.681Z
1363
0.5.5
2014-11-09T18:30:50.484Z
1427
0.5.4
2014-11-05T19:05:35.060Z
1032
0.5.3
2014-10-15T20:30:58.073Z
1154
0.5.2
2014-10-06T12:52:29.852Z
887
0.5.1
2014-09-11T17:45:56.087Z
1167
0.5.0
2014-09-10T19:18:14.269Z
350
0.4.3
2014-09-09T11:45:15.879Z
419
0.4.2
2014-09-07T17:23:29.357Z
461
0.4.1
2014-09-04T10:27:03.038Z
506
0.4.0
2014-09-03T21:02:59.076Z
256
0.3.3
2014-09-03T16:59:30.166Z
215
0.3.2
2014-08-29T09:36:20.016Z
591
0.3.1
2014-08-28T08:45:11.976Z
340
 Readme
# FuncDocr A brackets extension to generate JS/PHPDocs for your functions. ## Important change! I would like to use parser to offer better support! At the moment ES6 isn't supported in a good way and everything else are just regular expressions. Sorry I'm still learning :D Unfortunately I didn't find a parser to support PHP yet :/ There are two options now: Just waiting until I find a parser for PHP or use regexes for PHP and a parser for JS. I've several extensions and a lot of other projects and that upgrade will take a lot of time. Therefore it would be great if you can check out the next section ;) ## You're rich? You don't need a second yacht and have some coins to spend? Here I am :) [![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=Wikunia&url=https://github.com/Wikunia/brackets-FuncDocr&title=Brackets-FuncDocr&language=javascript&tags=github&category=software) [![Donate! :3](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=B5VQXWCZXYN2W) Current amount: 1.04€ ## How to Use * Open a JS or PHP file * set your cursor on a function declaration * `function cool(stuff)` * Use the ShortCut `Ctrl-Alt-D` (Win) or `Ctrl-Shift-D` (Mac) to start the documentation or `/**` + Enter The extension will provide a function documentation: Natural way: `/**` + Enter ![](https://cloud.githubusercontent.com/assets/4931746/4238565/c820925e-39d9-11e4-998b-693c25b3a5b1.gif) With shortcut: ![](https://cloud.githubusercontent.com/assets/4931746/4141317/f9303404-33ac-11e4-8e3c-c72925b4e550.gif) `[[Description]]` will be selected so you can start to type. To jump to the next `[[tag]]` you can use `Tab` or jump to the last with `Shift-Tab`. The indenting updates on a tab jump (live indenting). You will get hints for the `[[Type]]` tag. ![Type hints](https://cloud.githubusercontent.com/assets/4931746/3998983/b3eba9ba-294c-11e4-988b-4330735635fd.png) Have fun and stay tuned! ## v0.8.4 - It's possible to disable the autoindent functionality in the settings menu. - `@callback` links will be visible as `[[Type]]` hints. ## v0.8.0 You can use several JSDoc options to describe your function and you can dblclick on `[[...]]` to edit the tags. ![funcdocr0 8 0](https://cloud.githubusercontent.com/assets/4931746/5670323/2c266c44-977f-11e4-8683-6b1923c66edf.gif) ## v0.7.0 Document your react functions! ![funcdocr0 7 0](https://cloud.githubusercontent.com/assets/4931746/5670498/a3024bf2-9780-11e4-8bd9-448ef4f04496.gif) ## v0.6.0 ## @link tags ![linkTag](https://cloud.githubusercontent.com/assets/4931746/5079729/78a7cc3e-6eb7-11e4-8502-7718bf7c0c97.gif) Easy way to add @link tags to your docs! ## v0.5.3 ### Default values! ![Default values](https://cloud.githubusercontent.com/assets/4931746/4649697/18f8859c-548d-11e4-9f86-9a9a669b71f2.gif) ## v0.5.0 + It's possible to generate the doc block with `/**` + Enter. You only need to type `/**` in the line above the function declaration and use enter to start the documentation. ## v0.4.0 + The padding for correct indentation updates on a tab jump ## v0.3.0 + It's possible to update a doc block if you add a parameter or delete one (you need to use the shortcut again) ## v0.2.0 + You get the tag `@returns` if the function returns a value + The `[[Type]]` is recognized if possible.