https://github.com/matt-lough/solidity-docstring-generator

Sublime Plugin for generating Solidity Docstrings
https://github.com/matt-lough/solidity-docstring-generator

Last synced: 27 days ago
JSON representation

Sublime Plugin for generating Solidity Docstrings

• Host: GitHub
• URL: https://github.com/matt-lough/solidity-docstring-generator
• Owner: matt-lough
• Created: 2018-03-12T01:34:59.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-03-20T00:50:07.000Z (over 6 years ago)
• Last Synced: 2024-01-28T23:10:22.239Z (almost 2 years ago)
• Language: Python
• Size: 9.77 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

• awesome-solidity - Solidity Doc generator

README

          
Solidity Docstring Generator

============================

[Sublime Text](http://www.sublimetext.com/) plugin to automatically generate Docstrings for Solidity smart contracts.

Solidity Docstring Generator allows you to do this:

![Gif of usage](https://i.imgur.com/FRNyJwh.gif)

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).