Skip to content

Commit b6cd251

Browse files
committed
learning VS Code Marketplace, added changelog
1 parent d9d4583 commit b6cd251

File tree

3 files changed

+67
-6
lines changed

3 files changed

+67
-6
lines changed

CHANGELOG.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Changelog
2+
3+
## v1.1.2 Release
4+
5+
- still learning VS Code Marketplace, added changelog
6+
- fixed typos
7+
8+
## v1.1.1 Release
9+
10+
- learning VS Code Marketplace
11+
- updated the README with Marketplace info
12+
- bumped version.
13+
14+
## v1.1.0 Release
15+
16+
- First public release
17+
18+
## v1.0.4 Release Candidate 5
19+
20+
- refactored duplicated code
21+
22+
## v1.0.3 Release Candidate 4
23+
24+
- fixed bug with payable keyword in the argument list
25+
26+
## v1.0.2 Release Candidate 3
27+
28+
Implemented exact matching of keywords with regular expressions so a parameter as _contract or interface1 etc. still generate correct tags.
29+
30+
## v1.0.0 Release Candidate 1
31+
32+
- updated metadata
33+
- improved ReadMe
34+
35+
## v1.0.0 Release Candidate 1
36+
37+
This is the first (pre-)release of VS Code Solidity documentation helper.
38+
39+
It recognizes contract, interface, library, function and modifier keywords on the current line and adds NatSpec doc comments above the line.
40+
41+
For contract, interface and library keywords the extension adds a header as follows:
42+
43+
```
44+
/**
45+
* @author .
46+
* @title .
47+
* @dev .
48+
* @notice .
49+
*/
50+
```
51+
52+
For function and modifier keywords the extension adds comments as follows:
53+
54+
```
55+
/**
56+
* @notice .
57+
* @dev .
58+
* @param _address .
59+
* @return bool .
60+
*/
61+
```

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ This extension simplifies addition of NatSpec compliant @author, @title, @notice
44

55
## Installation
66

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

1414
## Using
1515

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"categories": [
2626
"Other"
2727
],
28-
"version": "1.1.1",
28+
"version": "1.1.2",
2929
"publisher": "chainbloq-labs",
3030
"engines": {
3131
"vscode": "^0.10.0"

0 commit comments

Comments
 (0)