Skip to content

Commit

Permalink
learning VS Code Marketplace, added changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
ngurmen committed Oct 3, 2022
1 parent d9d4583 commit b6cd251
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 6 deletions.
61 changes: 61 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Changelog

## v1.1.2 Release

- still learning VS Code Marketplace, added changelog
- fixed typos

## v1.1.1 Release

- learning VS Code Marketplace
- updated the README with Marketplace info
- bumped version.

## v1.1.0 Release

- First public release

## v1.0.4 Release Candidate 5

- refactored duplicated code

## v1.0.3 Release Candidate 4

- fixed bug with payable keyword in the argument list

## v1.0.2 Release Candidate 3

Implemented exact matching of keywords with regular expressions so a parameter as _contract or interface1 etc. still generate correct tags.

## v1.0.0 Release Candidate 1

- updated metadata
- improved ReadMe

## v1.0.0 Release Candidate 1

This is the first (pre-)release of VS Code Solidity documentation helper.

It recognizes contract, interface, library, function and modifier keywords on the current line and adds NatSpec doc comments above the line.

For contract, interface and library keywords the extension adds a header as follows:

```
/**
* @author .
* @title .
* @dev .
* @notice .
*/
```

For function and modifier keywords the extension adds comments as follows:

```
/**
* @notice .
* @dev .
* @param _address .
* @return bool .
*/
```
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ This extension simplifies addition of NatSpec compliant @author, @title, @notice

## Installation

The solidity-comments VS Code extension can be installed 1. from a VSIX file or 2. from VS Code Marketplace.
1. The VSIX file can be downloaded from the [release page](https://github.com/Dexalot/vscode-solidity-comments/releases) on GitHub.
- Go to `Extensions` tab and click the `...` at the top.
The solidity-comments VS Code extension can be installed 1. from VS Code Marketplace or 1. from a VSIX file.
1. On the VS Code Marketplace the extension can be found with its name vscode-solidity-comments.
- Click Install.
2. The VSIX file can be downloaded from the [release page](https://github.com/Dexalot/vscode-solidity-comments/releases) on GitHub.
- Go to `Extensions` tab in VS Code and click `...` at the top.
- Select `Install from VSIX` and point the file selector dialog to the downloaded VSIX file.
3. On the VS Code Marketplace the extension can be found with its name vscode-solidity-comments.
- Just clisk Install.

## Using

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"categories": [
"Other"
],
"version": "1.1.1",
"version": "1.1.2",
"publisher": "chainbloq-labs",
"engines": {
"vscode": "^0.10.0"
Expand Down

0 comments on commit b6cd251

Please sign in to comment.