matt-lough / solidity-docstring-generator

Sublime Plugin for generating Solidity Docstrings

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Solidity Docstring Generator

Sublime Text plugin to automatically generate Docstrings for Solidity smart contracts.

Solidity Docstring Generator allows you to do this:

Gif of usage

Installation

Package Control (recommended)

  • Open the command palette is Sulbime (Command+Shift+P on Mac, Ctrl+Shift+P on Linux/Windows)
  • Use the "Package Control: Install Package" command and search for "Solidity Docstring Generator

Manually

Add SolidityDocString.py and SolidityDocstringGenerator.sublime-commands to your Packages directory.

(OSX): Users\”Username”\Library\Application Support\Sublime Text 3\Packages (WIN7): C:\Users\”Username”\AppData\Roaming\Sublime Text 3\Packages

Usage

Use the Generate Solidity Docstrings command through the command palette (Command+Shift+P on Mac, Ctrl+Shift+P on Linux/Windows).

About

Sublime Plugin for generating Solidity Docstrings


Languages

Language:Python 100.0%