https://github.com/atomrc/kakoune-jsdoc

Kakoune JSDoc generator
https://github.com/atomrc/kakoune-jsdoc

jsdoc kakoune

Last synced: about 1 month ago
JSON representation

Kakoune JSDoc generator

• Host: GitHub
• URL: https://github.com/atomrc/kakoune-jsdoc
• Owner: atomrc
• Created: 2017-07-31T15:55:47.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-07-24T20:50:00.000Z (over 6 years ago)
• Last Synced: 2024-10-20T07:45:32.472Z (2 months ago)
• Topics: jsdoc, kakoune
• Size: 178 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kakoune JSDoc generator

Helps you generate JSDoc from [kakoune](http://kakoune.org)

![jsdoc generator demo](/screenshots/demo.gif)

# Install

Copy the `jsdoc.kak` file in your `~/.config/kak/autoload/` folder.

It will add the `jsdoc` function when a `javascript` file is detected

# Generate JSDoc

To generate jsdoc, put the cursor in a line containing a function declaration, then run

    :jsdoc

    

It will parses the function's declaration and extract the name and parameters of the function

You could also add a shortcut to generate doc quickly (here `,d`)

    hook global WinSetOption filetype=javascript %{

      map global user d ':jsdoc' -docstring "Generate jsdoc"

    }

# Limitation

- it only works for function declaration 

- it's having some hard times with destructured objects as function parameters