cerc-io/solidity
11
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update natspec comments on state variables.

Browse Source 
- changing some warnings to errors
This commit is contained in:
Alexander Arlt
2020-05-26 11:18:24 -05:00
parent 189d30b3ee
commit cb5bfc7436
9 changed files with 26 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/libsolidity/SolidityParser.cpp
+4 -4
View File
@@ -254,7 +254,7 @@ BOOST_AUTO_TEST_CASE(natspec_comment_in_function_body)
/// fun1 description
function fun1(uint256 a) {
var b;
/// I should not interfere with actual natspec comments
// I should not interfere with actual natspec comments (natspec comments on local variables not allowed anymore)
uint256 c;
mapping(address=>bytes32) d;
bytes7 name = "Solidity";
@@ -286,7 +286,7 @@ BOOST_AUTO_TEST_CASE(natspec_docstring_between_keyword_and_signature)
function ///I am in the wrong place
fun1(uint256 a) {
var b;
/// I should not interfere with actual natspec comments
// I should not interfere with actual natspec comments (natspec comments on local variables not allowed anymore)
uint256 c;
mapping(address=>bytes32) d;
bytes7 name = "Solidity";
@@ -310,9 +310,9 @@ BOOST_AUTO_TEST_CASE(natspec_docstring_after_signature)
contract test {
uint256 stateVar;
function fun1(uint256 a) {
/// I should have been above the function signature
// I should have been above the function signature (natspec comments on local variables not allowed anymore)
var b;
/// I should not interfere with actual natspec comments
// I should not interfere with actual natspec comments (natspec comments on local variables not allowed anymore)
uint256 c;
mapping(address=>bytes32) d;
bytes7 name = "Solidity";
test/libsolidity/syntaxTests/natspec/docstring_author_title_state_variable.sol
+2 -1
View File
@@ -4,4 +4,5 @@ contract C {
uint private state;
}
// ----
// Warning: (17-56): Documentation tag @title and @author is only allowed on contract definitions. It will be disallowed in 0.7.0.
// DocstringParsingError: (17-56): Documentation tag @author not valid for non-public state variables.
// DocstringParsingError: (17-56): Documentation tag @title not valid for non-public state variables.
test/libsolidity/syntaxTests/natspec/docstring_non_public_state_variable_with_return.sol
+1 -1
View File
@@ -3,4 +3,4 @@ contract test {
uint private state;
}
// ----
// DocstringParsingError: (18-47): Documentation tag "@return" is only allowed on public state-variables.
// DocstringParsingError: (18-47): Documentation tag @return not valid for non-public state variables.
test/libsolidity/syntaxTests/natspec/docstring_private_state_variable.sol
+1 -1
View File
@@ -4,4 +4,4 @@ contract C {
uint private state;
}
// ----
// Warning: (17-74): Documentation tag on non-public state variables will be disallowed in 0.7.0. You will need to use the @dev tag explicitly.
// DocstringParsingError: (17-74): Documentation tag @notice not valid for non-public state variables.
test/libsolidity/syntaxTests/natspec/docstring_variable.sol
+1 -1
View File
@@ -11,4 +11,4 @@ contract C {
}
}
// ----
// Warning: (290-295): Only state variables can have a docstring. This will be disallowed in 0.7.0.
// ParserError: (290-295): Only state variables can have a docstring.