Skip to content

FuncDocr generates JS/PHPDoc annotations for your functions

Notifications You must be signed in to change notification settings

qyouqme/brackets-FuncDocr

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FuncDocr

A brackets extension to generate JS/PHPDocs for your functions.

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

With shortcut:

[[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

Have fun and stay tuned!

v0.6.0

@link tags

linkTag

Easy way to add @link tags to your docs!

v0.5.3

Default values!

Default values

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.

About

FuncDocr generates JS/PHPDoc annotations for your functions

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%