cerc-io/solidity
16
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

SolidityNatspecJSON: Convert Boost-based test cases into natspectJSON/*.sol tests

Browse Source
This commit is contained in:
Kamil Śliwak 2023-08-09 18:16:14 +02:00
parent ba019e5a01
commit 99bfdf930a
91 changed files with 3103 additions and 3298 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
test/CMakeLists.txt
View File

@ -97,7 +97,6 @@ set(libsolidity_sources
libsolidity/SolidityExecutionFramework.h
libsolidity/SolidityExpressionCompiler.cpp
libsolidity/SolidityNameAndTypeResolution.cpp
libsolidity/SolidityNatspecJSON.cpp
libsolidity/SolidityOptimizer.cpp
libsolidity/SolidityParser.cpp
libsolidity/SolidityTypes.cpp

3297
test/libsolidity/SolidityNatspecJSON.cpp
View File

File diff suppressed because it is too large Load Diff

34
test/libsolidity/natspecJSON/custom.sol Normal file
View File

@ -0,0 +1,34 @@
/// @custom:x one two three
/// @custom:y line
/// break
/// @custom:t one
/// @custom:t two
contract A {
/// @custom:note statevar
uint x;
/// @custom:since 2014
function g(int x) public pure virtual returns (int, int) { return (1, 2); }
}
// ----
// ----
// :A devdoc
// {
// "custom:t": "onetwo",
// "custom:x": "one two three",
// "custom:y": "line break",
// "methods":
// {
// "g(int256)":
// {
// "custom:since": "2014"
// }
// },
// "stateVariables":
// {
// "x":
// {
// "custom:note": "statevar"
// }
// }
// }

25
test/libsolidity/natspecJSON/custom_inheritance.sol Normal file
View File

@ -0,0 +1,25 @@
contract A {
/// @custom:since 2014
function g(uint x) public pure virtual {}
}
contract B is A {
function g(uint x) public pure override {}
}
// ----
// ----
// :A devdoc
// {
// "methods":
// {
// "g(uint256)":
// {
// "custom:since": "2014"
// }
// }
// }
//
// :B devdoc
// {
// "methods": {}
// }

29
test/libsolidity/natspecJSON/dev_and_user_basic_test.sol Normal file
View File

@ -0,0 +1,29 @@
contract test {
/// @notice Multiplies `a` by 7
/// @dev Multiplies a number by 7
function mul(uint a) public returns (uint d) { return a * 7; }
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256)":
// {
// "details": "Multiplies a number by 7"
// }
// }
// }
//
// :test userdoc
// {
// "methods":
// {
// "mul(uint256)":
// {
// "notice": "Multiplies `a` by 7"
// }
// }
// }

20
test/libsolidity/natspecJSON/dev_and_user_no_doc.sol Normal file
View File

@ -0,0 +1,20 @@
contract test {
function mul(uint a) public returns (uint d) {
return a * 7;
}
function sub(int input) public returns (int d) {
return input - 3;
}
}
// ----
// ----
// :test devdoc
// {
// "methods": {}
// }
//
// :test userdoc
// {
// "methods": {}
// }

9
test/libsolidity/natspecJSON/dev_author_at_function.sol Normal file
View File

@ -0,0 +1,9 @@
/// @author Lefteris
/// @title Just a test contract
contract test {
/// @dev Mul function
/// @author John Doe
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----

22
test/libsolidity/natspecJSON/dev_constructor.sol Normal file
View File

@ -0,0 +1,22 @@
contract test {
/// @param a the parameter a is really nice and very useful
/// @param second the second parameter is not very useful, it just provides additional confusion
constructor(uint a, uint second) { }
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "constructor":
// {
// "params":
// {
// "a": "the parameter a is really nice and very useful",
// "second": "the second parameter is not very useful, it just provides additional confusion"
// }
// }
// }
// }

44
test/libsolidity/natspecJSON/dev_constructor_and_function.sol Normal file
View File

@ -0,0 +1,44 @@
contract test {
/// @param a the parameter a is really nice and very useful
/// @param second the second parameter is not very useful, it just provides additional confusion
constructor(uint a, uint second) { }
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter starts here.
/// Since it's a really complicated parameter we need 2 lines
/// @param second Documentation for the second parameter
/// @return d The result of the multiplication
/// and cookies with nutella
function mul(uint a, uint second) public returns(uint d) {
return a * 7 + second;
}
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "constructor":
// {
// "params":
// {
// "a": "the parameter a is really nice and very useful",
// "second": "the second parameter is not very useful, it just provides additional confusion"
// }
// },
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines",
// "second": "Documentation for the second parameter"
// },
// "returns":
// {
// "d": "The result of the multiplication and cookies with nutella"
// }
// }
// }
// }

8
test/libsolidity/natspecJSON/dev_constructor_return.sol Normal file
View File

@ -0,0 +1,8 @@
contract test {
/// @param a the parameter a is really nice and very useful
/// @param second the second parameter is not very useful, it just provides additional confusion
/// @return return should not work within constructors
constructor(uint a, uint second) { }
}
// ----

21
test/libsolidity/natspecJSON/dev_contract_doc.sol Normal file
View File

@ -0,0 +1,21 @@
/// @author Lefteris
/// @title Just a test contract
contract test {
/// @dev Mul function
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----
// ----
// :test devdoc
// {
// "author": "Lefteris",
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Mul function"
// }
// },
// "title": "Just a test contract"
// }

17
test/libsolidity/natspecJSON/dev_contract_no_doc.sol Normal file
View File

@ -0,0 +1,17 @@
contract test {
/// @dev Mul function
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Mul function"
// }
// }
// }

72
test/libsolidity/natspecJSON/dev_default_inherit.sol Normal file
View File

@ -0,0 +1,72 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// Second line.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract Middle is ERC20 {
function transfer(address to, uint amount) virtual override external returns (bool)
{
return false;
}
}
contract Token is Middle {
function transfer(address to, uint amount) override external returns (bool)
{
return false;
}
}
// ----
// ----
// :ERC20 devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }
//
// :Middle devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }
//
// :Token devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }

36
test/libsolidity/natspecJSON/dev_default_inherit_variable.sol Normal file
View File

@ -0,0 +1,36 @@
contract C {
/// @notice Hello world
/// @dev test
function x() virtual external returns (uint) {
return 1;
}
}
contract D is C {
uint public override x;
}
// ----
// ----
// :C devdoc
// {
// "methods":
// {
// "x()":
// {
// "details": "test"
// }
// }
// }
//
// :D devdoc
// {
// "methods": {},
// "stateVariables":
// {
// "x":
// {
// "details": "test"
// }
// }
// }

25
test/libsolidity/natspecJSON/dev_desc_after_nl.sol Normal file
View File

@ -0,0 +1,25 @@
contract test {
/// @dev
/// Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter
/// @param second Documentation for the second parameter
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter",
// "second": "Documentation for the second parameter"
// }
// }
// }
// }

38
test/libsolidity/natspecJSON/dev_different_return_name.sol Normal file
View File

@ -0,0 +1,38 @@
contract A {
/// @return y value
function g(int x) public pure virtual returns (int y) { return x; }
}
contract B is A {
function g(int x) public pure override returns (int z) { return x; }
}
// ----
// ----
// :A devdoc
// {
// "methods":
// {
// "g(int256)":
// {
// "returns":
// {
// "y": "value"
// }
// }
// }
// }
//
// :B devdoc
// {
// "methods":
// {
// "g(int256)":
// {
// "returns":
// {
// "z": "value"
// }
// }
// }
// }

41
test/libsolidity/natspecJSON/dev_different_return_name_multiple.sol Normal file
View File

@ -0,0 +1,41 @@
contract A {
/// @return a value A
/// @return b value B
function g(int x) public pure virtual returns (int a, int b) { return (1, 2); }
}
contract B is A {
function g(int x) public pure override returns (int z, int y) { return (1, 2); }
}
// ----
// ----
// :A devdoc
// {
// "methods":
// {
// "g(int256)":
// {
// "returns":
// {
// "a": "value A",
// "b": "value B"
// }
// }
// }
// }
//
// :B devdoc
// {
// "methods":
// {
// "g(int256)":
// {
// "returns":
// {
// "y": "value B",
// "z": "value A"
// }
// }
// }
// }

41
test/libsolidity/natspecJSON/dev_different_return_name_multiple_partly_unnamed.sol Normal file
View File

@ -0,0 +1,41 @@
contract A {
/// @return value A
/// @return b value B
function g(int x) public pure virtual returns (int, int b) { return (1, 2); }
}
contract B is A {
function g(int x) public pure override returns (int z, int) { return (1, 2); }
}
// ----
// ----
// :A devdoc
// {
// "methods":
// {
// "g(int256)":
// {
// "returns":
// {
// "_0": "value A",
// "b": "value B"
// }
// }
// }
// }
//
// :B devdoc
// {
// "methods":
// {
// "g(int256)":
// {
// "returns":
// {
// "_1": "value B",
// "z": "value A"
// }
// }
// }
// }

41
test/libsolidity/natspecJSON/dev_different_return_name_multiple_unnamed.sol Normal file
View File

@ -0,0 +1,41 @@
contract A {
/// @return value A
/// @return value B
function g(int x) public pure virtual returns (int, int) { return (1, 2); }
}
contract B is A {
function g(int x) public pure override returns (int z, int y) { return (1, 2); }
}
// ----
// ----
// :A devdoc
// {
// "methods":
// {
// "g(int256)":
// {
// "returns":
// {
// "_0": "value A",
// "_1": "value B"
// }
// }
// }
// }
//
// :B devdoc
// {
// "methods":
// {
// "g(int256)":
// {
// "returns":
// {
// "y": "value B",
// "z": "value A"
// }
// }
// }
// }

8
test/libsolidity/natspecJSON/dev_documenting_no_param_description.sol Normal file
View File

@ -0,0 +1,8 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter
/// @param second
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----

8
test/libsolidity/natspecJSON/dev_documenting_no_param_name.sol Normal file
View File

@ -0,0 +1,8 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter
/// @param
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----

8
test/libsolidity/natspecJSON/dev_documenting_no_param_name_end.sol Normal file
View File

@ -0,0 +1,8 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter
/// @param se
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----

9
test/libsolidity/natspecJSON/dev_documenting_no_return_param_name.sol Normal file
View File

@ -0,0 +1,9 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter
/// @param second Documentation for the second parameter
/// @return
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----

8
test/libsolidity/natspecJSON/dev_documenting_nonexistent_param.sol Normal file
View File

@ -0,0 +1,8 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter
/// @param not_existing Documentation for the second parameter
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----

54
test/libsolidity/natspecJSON/dev_explicit_inherit.sol Normal file
View File

@ -0,0 +1,54 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract ERC21 {
function transfer(address to, uint amount) virtual external returns (bool) {
return false;
}
}
contract Token is ERC21, ERC20 {
/// @inheritdoc ERC20
function transfer(address to, uint amount) override(ERC21, ERC20) external returns (bool) {
return false;
}
}
// ----
// ----
// :ERC20 devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }
//
// :Token devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }

70
test/libsolidity/natspecJSON/dev_explicit_inherit2.sol Normal file
View File

@ -0,0 +1,70 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract ERC21 is ERC20 {
function transfer(address to, uint amount) virtual override external returns (bool) {
return false;
}
}
contract Token is ERC20 {
/// @inheritdoc ERC20
function transfer(address to, uint amount) override external returns (bool) {
return false;
}
}
// ----
// ----
// :ERC20 devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }
//
// :ERC21 devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }
//
// :Token devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }

56
test/libsolidity/natspecJSON/dev_explicit_inherit_partial.sol Normal file
View File

@ -0,0 +1,56 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract ERC21 {
function transfer(address to, uint amount) virtual external returns (bool) {
return false;
}
}
contract Token is ERC21, ERC20 {
/// @inheritdoc ERC20
/// @dev override dev comment
/// @notice override notice
function transfer(address to, uint amount) override(ERC21, ERC20) external returns (bool) {
return false;
}
}
// ----
// ----
// :ERC20 devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }
//
// :Token devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "override dev comment",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }

56
test/libsolidity/natspecJSON/dev_explicit_inherit_partial2.sol Normal file
View File

@ -0,0 +1,56 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract ERC21 is ERC20 {
/// @inheritdoc ERC20
/// @dev override dev comment
/// @notice override notice
function transfer(address to, uint amount) virtual override external returns (bool) {
return false;
}
}
contract Token is ERC21 {
function transfer(address to, uint amount) override external returns (bool) {
return false;
}
}
// ----
// ----
// :ERC20 devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }
//
// :Token devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "override dev comment",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }

43
test/libsolidity/natspecJSON/dev_explicit_inherit_variable.sol Normal file
View File

@ -0,0 +1,43 @@
contract B {
function x() virtual external returns (uint) {
return 1;
}
}
contract C {
/// @notice Hello world
/// @dev test
function x() virtual external returns (uint) {
return 1;
}
}
contract D is C, B {
/// @inheritdoc C
uint public override(C, B) x;
}
// ----
// ----
// :C devdoc
// {
// "methods":
// {
// "x()":
// {
// "details": "test"
// }
// }
// }
//
// :D devdoc
// {
// "methods": {},
// "stateVariables":
// {
// "x":
// {
// "details": "test"
// }
// }
// }

58
test/libsolidity/natspecJSON/dev_inherit_parameter_mismatch.sol Normal file
View File

@ -0,0 +1,58 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract Middle is ERC20 {
function transfer(address to, uint amount) override virtual external returns (bool) {
return false;
}
}
contract Token is Middle {
function transfer(address too, uint amount) override external returns (bool) {
return false;
}
}
// ----
// ----
// :ERC20 devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }
//
// :Middle devdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// }
// }
//
// :Token devdoc
// {
// "methods": {}
// }

35
test/libsolidity/natspecJSON/dev_multiline_comment.sol Normal file
View File

@ -0,0 +1,35 @@
contract test {
/**
* @dev Multiplies a number by 7 and adds second parameter
* @param a Documentation for the first parameter starts here.
* Since it's a really complicated parameter we need 2 lines
* @param second Documentation for the second parameter
* @return d The result of the multiplication
* and cookies with nutella
*/
function mul(uint a, uint second) public returns (uint d) {
return a * 7 + second;
}
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines",
// "second": "Documentation for the second parameter"
// },
// "returns":
// {
// "d": "The result of the multiplication and cookies with nutella"
// }
// }
// }
// }

33
test/libsolidity/natspecJSON/dev_multiline_return.sol Normal file
View File

@ -0,0 +1,33 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter starts here.
/// Since it's a really complicated parameter we need 2 lines
/// @param second Documentation for the second parameter
/// @return d The result of the multiplication
/// and cookies with nutella
function mul(uint a, uint second) public returns (uint d) {
return a * 7 + second;
}
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines",
// "second": "Documentation for the second parameter"
// },
// "returns":
// {
// "d": "The result of the multiplication and cookies with nutella"
// }
// }
// }
// }

54
test/libsolidity/natspecJSON/dev_multiple_functions.sol Normal file
View File

@ -0,0 +1,54 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter
/// @param second Documentation for the second parameter
function mul(uint a, uint second) public returns (uint d) {
return a * 7 + second;
}
/// @dev Divides 2 numbers
/// @param input Documentation for the input parameter
/// @param div Documentation for the div parameter
function divide(uint input, uint div) public returns (uint d) {
return input / div;
}
/// @dev Subtracts 3 from `input`
/// @param input Documentation for the input parameter
function sub(int input) public returns (int d) {
return input - 3;
}
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "divide(uint256,uint256)":
// {
// "details": "Divides 2 numbers",
// "params":
// {
// "div": "Documentation for the div parameter",
// "input": "Documentation for the input parameter"
// }
// },
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter",
// "second": "Documentation for the second parameter"
// }
// },
// "sub(int256)":
// {
// "details": "Subtracts 3 from `input`",
// "params":
// {
// "input": "Documentation for the input parameter"
// }
// }
// }
// }

24
test/libsolidity/natspecJSON/dev_multiple_params.sol Normal file
View File

@ -0,0 +1,24 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter
/// @param second Documentation for the second parameter
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter",
// "second": "Documentation for the second parameter"
// }
// }
// }
// }

25
test/libsolidity/natspecJSON/dev_mutiline_param_description.sol Normal file
View File

@ -0,0 +1,25 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter starts here.
/// Since it's a really complicated parameter we need 2 lines
/// @param second Documentation for the second parameter
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines",
// "second": "Documentation for the second parameter"
// }
// }
// }
// }

30
test/libsolidity/natspecJSON/dev_return.sol Normal file
View File

@ -0,0 +1,30 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter starts here.
/// Since it's a really complicated parameter we need 2 lines
/// @param second Documentation for the second parameter
/// @return d The result of the multiplication
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines",
// "second": "Documentation for the second parameter"
// },
// "returns":
// {
// "d": "The result of the multiplication"
// }
// }
// }
// }

33
test/libsolidity/natspecJSON/dev_return_desc_after_nl.sol Normal file
View File

@ -0,0 +1,33 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter starts here.
/// Since it's a really complicated parameter we need 2 lines
/// @param second Documentation for the second parameter
/// @return
/// d The result of the multiplication
function mul(uint a, uint second) public returns (uint d) {
return a * 7 + second;
}
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines",
// "second": "Documentation for the second parameter"
// },
// "returns":
// {
// "d": "The result of the multiplication"
// }
// }
// }
// }

35
test/libsolidity/natspecJSON/dev_return_desc_multiple.sol Normal file
View File

@ -0,0 +1,35 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter starts here.
/// Since it's a really complicated parameter we need 2 lines
/// @param second Documentation for the second parameter
/// @return d The result of the multiplication
/// @return f And cookies with nutella
function mul(uint a, uint second) public returns (uint d, uint f) {
uint mul = a * 7;
return (mul, second);
}
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines",
// "second": "Documentation for the second parameter"
// },
// "returns":
// {
// "d": "The result of the multiplication",
// "f": "And cookies with nutella"
// }
// }
// }
// }

35
test/libsolidity/natspecJSON/dev_return_desc_multiple_unamed.sol Normal file
View File

@ -0,0 +1,35 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter starts here.
/// Since it's a really complicated parameter we need 2 lines
/// @param second Documentation for the second parameter
/// @return The result of the multiplication
/// @return And cookies with nutella
function mul(uint a, uint second) public returns (uint, uint) {
uint mul = a * 7;
return (mul, second);
}
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines",
// "second": "Documentation for the second parameter"
// },
// "returns":
// {
// "_0": "The result of the multiplication",
// "_1": "And cookies with nutella"
// }
// }
// }
// }

35
test/libsolidity/natspecJSON/dev_return_desc_multiple_unamed_mixed.sol Normal file
View File

@ -0,0 +1,35 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter starts here.
/// Since it's a really complicated parameter we need 2 lines
/// @param second Documentation for the second parameter
/// @return The result of the multiplication
/// @return _cookies And cookies with nutella
function mul(uint a, uint second) public returns (uint, uint _cookies) {
uint mul = a * 7;
return (mul, second);
}
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines",
// "second": "Documentation for the second parameter"
// },
// "returns":
// {
// "_0": "The result of the multiplication",
// "_cookies": "And cookies with nutella"
// }
// }
// }
// }

38
test/libsolidity/natspecJSON/dev_return_desc_multiple_unamed_mixed_2.sol Normal file
View File

@ -0,0 +1,38 @@
contract test {
/// @dev Multiplies a number by 7 and adds second parameter
/// @param a Documentation for the first parameter starts here.
/// Since it's a really complicated parameter we need 2 lines
/// @param second Documentation for the second parameter
/// @return _cookies And cookies with nutella
/// @return The result of the multiplication
/// @return _milk And milk with nutella
function mul(uint a, uint second) public returns (uint _cookies, uint, uint _milk) {
uint mul = a * 7;
uint milk = 4;
return (mul, second, milk);
}
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Multiplies a number by 7 and adds second parameter",
// "params":
// {
// "a": "Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines",
// "second": "Documentation for the second parameter"
// },
// "returns":
// {
// "_1": "The result of the multiplication",
// "_cookies": "And cookies with nutella",
// "_milk": "And milk with nutella"
// }
// }
// }
// }

38
test/libsolidity/natspecJSON/dev_return_name_no_description.sol Normal file
View File

@ -0,0 +1,38 @@
contract A {
/// @return a
function g(int x) public pure virtual returns (int a) { return 2; }
}
contract B is A {
function g(int x) public pure override returns (int b) { return 2; }
}
// ----
// ----
// :A devdoc
// {
// "methods":
// {
// "g(int256)":
// {
// "returns":
// {
// "a": "a"
// }
// }
// }
// }
//
// :B devdoc
// {
// "methods":
// {
// "g(int256)":
// {
// "returns":
// {
// "b": "a"
// }
// }
// }
// }

20
test/libsolidity/natspecJSON/dev_return_no_params.sol Normal file
View File

@ -0,0 +1,20 @@
contract test {
/// @return d The result of the multiplication
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----
// ----
// :test devdoc
// {
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "returns":
// {
// "d": "The result of the multiplication"
// }
// }
// }
// }

47
test/libsolidity/natspecJSON/dev_struct_getter_override.sol Normal file
View File

@ -0,0 +1,47 @@
interface IThing {
/// @return x a number
/// @return y another number
function value() external view returns (uint128 x, uint128 y);
}
contract Thing is IThing {
struct Value {
uint128 x;
uint128 y;
}
Value public override value;
}
// ----
// ----
// :IThing devdoc
// {
// "methods":
// {
// "value()":
// {
// "returns":
// {
// "x": "a number",
// "y": "another number"
// }
// }
// }
// }
//
// :Thing devdoc
// {
// "methods": {},
// "stateVariables":
// {
// "value":
// {
// "returns":
// {
// "x": "a number",
// "y": "another number"
// }
// }
// }
// }

47
test/libsolidity/natspecJSON/dev_struct_getter_override_different_return_parameter_names.sol Normal file
View File

@ -0,0 +1,47 @@
interface IThing {
/// @return x a number
/// @return y another number
function value() external view returns (uint128 x, uint128 y);
}
contract Thing is IThing {
struct Value {
uint128 a;
uint128 b;
}
Value public override value;
}
// ----
// ----
// :IThing devdoc
// {
// "methods":
// {
// "value()":
// {
// "returns":
// {
// "x": "a number",
// "y": "another number"
// }
// }
// }
// }
//
// :Thing devdoc
// {
// "methods": {},
// "stateVariables":
// {
// "value":
// {
// "returns":
// {
// "a": "a number",
// "b": "another number"
// }
// }
// }
// }

44
test/libsolidity/natspecJSON/dev_struct_getter_override_no_return_name.sol Normal file
View File

@ -0,0 +1,44 @@
interface IThing {
///@return
function value(uint) external returns (uint128,uint128);
}
contract Thing is IThing {
struct Value {
uint128 x;
uint128 A;
}
mapping(uint=>Value) public override value;
}
// ----
// ----
// :IThing devdoc
// {
// "methods":
// {
// "value(uint256)":
// {
// "returns":
// {
// "_0": ""
// }
// }
// }
// }
//
// :Thing devdoc
// {
// "methods": {},
// "stateVariables":
// {
// "value":
// {
// "return": "x ",
// "returns":
// {
// "x": ""
// }
// }
// }
// }

9
test/libsolidity/natspecJSON/dev_title_at_function_error.sol Normal file
View File

@ -0,0 +1,9 @@
/// @author Lefteris
/// @title Just a test contract
contract test {
/// @dev Mul function
/// @title I really should not be here
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
// ----

41
test/libsolidity/natspecJSON/emit_event_from_foreign_contract.sol Normal file
View File

@ -0,0 +1,41 @@
contract X {
/// @notice Userdoc for event E.
/// @dev Devdoc for event E.
event E();
}
contract C {
function g() public {
emit X.E();
}
}
// ----
// ----
// :C devdoc
// {
// "events":
// {
// "E()":
// {
// "details": "Devdoc for event E."
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "events":
// {
// "E()":
// {
// "notice": "Userdoc for event E."
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

31
test/libsolidity/natspecJSON/emit_event_from_foreign_contract_no_inheritance.sol Normal file
View File

@ -0,0 +1,31 @@
// Tests that emitting an event from contract C in contract D does not inherit natspec from C.E
contract C {
/// @notice C.E event
/// @dev C.E event
event E();
}
contract D {
event E();
function test() public {
emit C.E();
}
}
// ----
// ----
// :D devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :D userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

74
test/libsolidity/natspecJSON/emit_event_from_foreign_contract_with_same_signature.sol Normal file
View File

@ -0,0 +1,74 @@
contract C {
/// @notice C.E event
/// @dev C.E event
event E(uint256 value);
}
contract D {
/// @notice D.E event
/// @dev D.E event
event E(uint256 value);
function test() public {
emit C.E(1);
emit E(2);
}
}
// ----
// ----
// :C devdoc
// {
// "events":
// {
// "E(uint256)":
// {
// "details": "C.E event"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "events":
// {
// "E(uint256)":
// {
// "notice": "C.E event"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :D devdoc
// {
// "events":
// {
// "E(uint256)":
// {
// "details": "D.E event"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :D userdoc
// {
// "events":
// {
// "E(uint256)":
// {
// "notice": "D.E event"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

66
test/libsolidity/natspecJSON/emit_same_signature_event_different_libraries.sol Normal file
View File

@ -0,0 +1,66 @@
library L1 {
/// @notice This event is defined in Library L1
/// @dev This should not appear in Contract C dev doc
event SameSignatureEvent(uint16);
}
library L2 {
/// @notice This event is defined in Library L2
/// @dev This should not appear in Contract C dev doc
event SameSignatureEvent(uint16);
}
library L3 {
/// @notice This event is defined in Library L3
/// @dev This should not appear in Contract C dev doc
event SameSignatureEvent(uint16);
}
contract C {
function f() public {
emit L1.SameSignatureEvent(0);
emit L2.SameSignatureEvent(1);
emit L3.SameSignatureEvent(2);
}
}
// ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :L1 devdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "details": "This should not appear in Contract C dev doc"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :L1 userdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "notice": "This event is defined in Library L1"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

34
test/libsolidity/natspecJSON/emit_same_signature_event_different_libraries_missing_natspec.sol Normal file
View File

@ -0,0 +1,34 @@
library L1 {
event SameSignatureEvent(uint16);
}
library L2 {
/// @notice This event is defined in library L2
/// @dev This should not appear in Contract C devdoc
event SameSignatureEvent(uint16);
}
library L3 {
event SameSignatureEvent(uint16);
}
contract C {
function f() public {
emit L1.SameSignatureEvent(0);
emit L2.SameSignatureEvent(1);
emit L3.SameSignatureEvent(2);
}
}
// ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

68
test/libsolidity/natspecJSON/emit_same_signature_event_library_contract.sol Normal file
View File

@ -0,0 +1,68 @@
library L {
/// @notice This event is defined in Library L
/// @dev This should not appear in Contract C dev doc
event SameSignatureEvent(uint16);
/// @notice This event is defined in Library L
/// @dev This should appear in Contract C dev doc
event LibraryEvent(uint32);
}
contract C {
/// @notice This event is defined in Contract C
/// @dev This should appear in Contract C dev doc
event SameSignatureEvent(uint16);
/// @notice This event is defined in Contract C
/// @dev This should appear in contract C dev doc
event ContractEvent(uint32);
function f() public {
emit L.SameSignatureEvent(0);
emit SameSignatureEvent(1);
emit L.LibraryEvent(2);
emit ContractEvent(3);
}
}
// ----
// ----
// :C devdoc
// {
// "events":
// {
// "ContractEvent(uint32)":
// {
// "details": "This should appear in contract C dev doc"
// },
// "LibraryEvent(uint32)":
// {
// "details": "This should appear in Contract C dev doc"
// },
// "SameSignatureEvent(uint16)":
// {
// "details": "This should appear in Contract C dev doc"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "events":
// {
// "ContractEvent(uint32)":
// {
// "notice": "This event is defined in Contract C"
// },
// "LibraryEvent(uint32)":
// {
// "notice": "This event is defined in Library L"
// },
// "SameSignatureEvent(uint16)":
// {
// "notice": "This event is defined in Contract C"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

53
test/libsolidity/natspecJSON/emit_same_signature_event_library_contract_missing_natspec.sol Normal file
View File

@ -0,0 +1,53 @@
library L {
/// @notice This event is defined in library L
/// @dev This should not appear in contract C devdoc
event SameSignatureEvent(uint16);
/// @notice This event is defined in library L
/// @dev This should appear in contract C devdoc
event LibraryEvent(uint32);
}
contract C {
event SameSignatureEvent(uint16);
/// @notice This event is defined in contract C
event ContractEvent(uint32);
function f() public {
emit L.SameSignatureEvent(0);
emit SameSignatureEvent(1);
emit L.LibraryEvent(2);
emit ContractEvent(3);
}
}
// ----
// ----
// :C devdoc
// {
// "events":
// {
// "LibraryEvent(uint32)":
// {
// "details": "This should appear in contract C devdoc"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "events":
// {
// "ContractEvent(uint32)":
// {
// "notice": "This event is defined in contract C"
// },
// "LibraryEvent(uint32)":
// {
// "notice": "This event is defined in library L"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

46
test/libsolidity/natspecJSON/emit_same_signature_event_library_inherited.sol Normal file
View File

@ -0,0 +1,46 @@
contract D {
/// @notice This event is defined in contract D
/// @dev This should appear in Contract C dev doc
event SameSignatureEvent(uint16);
}
library L {
/// @notice This event is defined in Library L
/// @dev This should not appear in Contract C
event SameSignatureEvent(uint16);
}
contract C is D {
function f() public {
emit L.SameSignatureEvent(0);
emit D.SameSignatureEvent(1);
}
}
// ----
// ----
// :C devdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "details": "This should appear in Contract C dev doc"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "notice": "This event is defined in contract D"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

30
test/libsolidity/natspecJSON/emit_same_signature_event_library_inherited_missing_natspec.sol Normal file
View File

@ -0,0 +1,30 @@
contract D {
event SameSignatureEvent(uint16);
}
library L {
/// @notice This event is defined in library L
/// @dev This should not appear in contract C devdoc
event SameSignatureEvent(uint16);
}
contract C is D {
function f() public {
emit L.SameSignatureEvent(0);
emit D.SameSignatureEvent(1);
}
}
// ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

10
test/libsolidity/natspecJSON/empty_comment.sol Normal file
View File

@ -0,0 +1,10 @@
//
contract test
{}
// ----
// ----
// :test userdoc
// {
// "methods": {}
// }

26
test/libsolidity/natspecJSON/enum_no_docs.sol Normal file
View File

@ -0,0 +1,26 @@
contract C {
/// @title example of title
/// @author example of author
/// @notice example of notice
/// @dev example of dev
enum Color {
Red,
Green
}
}
// ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

42
test/libsolidity/natspecJSON/error.sol Normal file
View File

@ -0,0 +1,42 @@
contract test {
/// Something failed.
/// @dev an error.
/// @param a first parameter
/// @param b second parameter
error E(uint a, uint b);
}
// ----
// ----
// :test devdoc
// {
// "errors":
// {
// "E(uint256,uint256)":
// [
// {
// "details": "an error.",
// "params":
// {
// "a": "first parameter",
// "b": "second parameter"
// }
// }
// ]
// },
// "methods": {}
// }
//
// :test userdoc
// {
// "errors":
// {
// "E(uint256,uint256)":
// [
// {
// "notice": "Something failed."
// }
// ]
// },
// "methods": {}
// }

66
test/libsolidity/natspecJSON/error_multiple.sol Normal file
View File

@ -0,0 +1,66 @@
contract A {
/// Something failed.
/// @dev an error.
/// @param x first parameter
/// @param y second parameter
error E(uint x, uint y);
}
contract test {
/// X Something failed.
/// @dev X an error.
/// @param a X first parameter
/// @param b X second parameter
error E(uint a, uint b);
function f(bool a) public pure {
if (a)
revert E(1, 2);
else
revert A.E(5, 6);
}
}
// ----
// ----
// :test devdoc
// {
// "errors":
// {
// "E(uint256,uint256)":
// [
// {
// "details": "an error.",
// "params":
// {
// "x": "first parameter",
// "y": "second parameter"
// }
// },
// {
// "details": "X an error.",
// "params":
// {
// "a": "X first parameter",
// "b": "X second parameter"
// }
// }
// ]
// },
// "methods": {}
// }
//
// :test userdoc
// {
// "errors":
// {
// "E(uint256,uint256)":
// [
// {
// "notice": "Something failed."
// },
// {
// "notice": "X Something failed."
// }
// ]
// },
// "methods": {}
// }

40
test/libsolidity/natspecJSON/event.sol Normal file
View File

@ -0,0 +1,40 @@
contract ERC20 {
/// @notice This event is emitted when a transfer occurs.
/// @param from The source account.
/// @param to The destination account.
/// @param amount The amount.
/// @dev A test case!
event Transfer(address indexed from, address indexed to, uint amount);
}
// ----
// ----
// :ERC20 devdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "details": "A test case!",
// "params":
// {
// "amount": "The amount.",
// "from": "The source account.",
// "to": "The destination account."
// }
// }
// },
// "methods": {}
// }
//
// :ERC20 userdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// }

104
test/libsolidity/natspecJSON/event_inheritance.sol Normal file
View File

@ -0,0 +1,104 @@
contract ERC20 {
/// @notice This event is emitted when a transfer occurs.
/// @param from The source account.
/// @param to The destination account.
/// @param amount The amount.
/// @dev A test case!
event Transfer(address indexed from, address indexed to, uint amount);
}
contract A is ERC20 {
}
contract B is A {
}
// ----
// ----
// :A devdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "details": "A test case!",
// "params":
// {
// "amount": "The amount.",
// "from": "The source account.",
// "to": "The destination account."
// }
// }
// },
// "methods": {}
// }
//
// :A userdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// }
//
// :B devdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "details": "A test case!",
// "params":
// {
// "amount": "The amount.",
// "from": "The source account.",
// "to": "The destination account."
// }
// }
// },
// "methods": {}
// }
//
// :B userdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// }
//
// :ERC20 devdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "details": "A test case!",
// "params":
// {
// "amount": "The amount.",
// "from": "The source account.",
// "to": "The destination account."
// }
// }
// },
// "methods": {}
// }
//
// :ERC20 userdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// }

104
test/libsolidity/natspecJSON/event_inheritance_interface.sol Normal file
View File

@ -0,0 +1,104 @@
interface ERC20 {
/// @notice This event is emitted when a transfer occurs.
/// @param from The source account.
/// @param to The destination account.
/// @param amount The amount.
/// @dev A test case!
event Transfer(address indexed from, address indexed to, uint amount);
}
contract A is ERC20 {
}
contract B is A {
}
// ----
// ----
// :A devdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "details": "A test case!",
// "params":
// {
// "amount": "The amount.",
// "from": "The source account.",
// "to": "The destination account."
// }
// }
// },
// "methods": {}
// }
//
// :A userdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// }
//
// :B devdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "details": "A test case!",
// "params":
// {
// "amount": "The amount.",
// "from": "The source account.",
// "to": "The destination account."
// }
// }
// },
// "methods": {}
// }
//
// :B userdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// }
//
// :ERC20 devdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "details": "A test case!",
// "params":
// {
// "amount": "The amount.",
// "from": "The source account.",
// "to": "The destination account."
// }
// }
// },
// "methods": {}
// }
//
// :ERC20 userdoc
// {
// "events":
// {
// "Transfer(address,address,uint256)":
// {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// }

18
test/libsolidity/natspecJSON/multiline_notice_without_tag.sol Normal file
View File

@ -0,0 +1,18 @@
contract test {
/// I do something awesome
/// which requires two lines to explain
function mul(uint a) public returns (uint d) { return a * 7; }
}
// ----
// ----
// :test userdoc
// {
// "methods":
// {
// "mul(uint256)":
// {
// "notice": "I do something awesome which requires two lines to explain"
// }
// }
// }

17
test/libsolidity/natspecJSON/notice_without_tag.sol Normal file
View File

@ -0,0 +1,17 @@
contract test {
/// I do something awesome
function mul(uint a) public returns (uint d) { return a * 7; }
}
// ----
// ----
// :test userdoc
// {
// "methods":
// {
// "mul(uint256)":
// {
// "notice": "I do something awesome"
// }
// }
// }

23
test/libsolidity/natspecJSON/private_state_variable.sol Normal file
View File

@ -0,0 +1,23 @@
contract test {
/// @dev example of dev
uint private state;
}
// ----
// ----
// :test devdoc
// {
// "methods": {},
// "stateVariables":
// {
// "state":
// {
// "details": "example of dev"
// }
// }
// }
//
// :test userdoc
// {
// "methods": {}
// }

36
test/libsolidity/natspecJSON/public_state_variable.sol Normal file
View File

@ -0,0 +1,36 @@
contract test {
/// @notice example of notice
/// @dev example of dev
/// @return returns state
uint public state;
}
// ----
// ----
// :test devdoc
// {
// "methods": {},
// "stateVariables":
// {
// "state":
// {
// "details": "example of dev",
// "return": "returns state",
// "returns":
// {
// "_0": "returns state"
// }
// }
// }
// }
//
// :test userdoc
// {
// "methods":
// {
// "state()":
// {
// "notice": "example of notice"
// }
// }
// }

40
test/libsolidity/natspecJSON/public_state_variable_struct.sol Normal file
View File

@ -0,0 +1,40 @@
contract Bank {
struct Coin {
string observeGraphicURL;
string reverseGraphicURL;
}
/// @notice Get the n-th coin I own
/// @return observeGraphicURL Front pic
/// @return reverseGraphicURL Back pic
Coin[] public coinStack;
}
// ----
// ----
// :Bank devdoc
// {
// "methods": {},
// "stateVariables":
// {
// "coinStack":
// {
// "returns":
// {
// "observeGraphicURL": "Front pic",
// "reverseGraphicURL": "Back pic"
// }
// }
// }
// }
//
// :Bank userdoc
// {
// "methods":
// {
// "coinStack(uint256)":
// {
// "notice": "Get the n-th coin I own"
// }
// }
// }

13
test/libsolidity/natspecJSON/public_state_variable_struct_repeated.sol Normal file
View File

@ -0,0 +1,13 @@
contract Bank {
struct Coin {
string obverseGraphicURL;
string reverseGraphicURL;
}
/// @notice Get the n-th coin I own
/// @return obverseGraphicURL Front pic
/// @return obverseGraphicURL Front pic
Coin[] public coinStack;
}
// ----

18
test/libsolidity/natspecJSON/slash3_slash3.sol Normal file
View File

@ -0,0 +1,18 @@
contract test {
/// @notice lorem
/// ipsum
function f() public { }
}
// ----
// ----
// :test userdoc
// {
// "methods":
// {
// "f()":
// {
// "notice": "lorem ipsum"
// }
// }
// }

18
test/libsolidity/natspecJSON/slash3_slash4.sol Normal file
View File

@ -0,0 +1,18 @@
contract test {
/// @notice lorem
//// ipsum
function f() public { }
}
// ----
// ----
// :test userdoc
// {
// "methods":
// {
// "f()":
// {
// "notice": "lorem"
// }
// }
// }

11
test/libsolidity/natspecJSON/slash4.sol Normal file
View File

@ -0,0 +1,11 @@
contract test {
//// @notice lorem ipsum
function f() public { }
}
// ----
// ----
// :test userdoc
// {
// "methods": {}
// }

13
test/libsolidity/natspecJSON/star3.sol Normal file
View File

@ -0,0 +1,13 @@
contract test {
/***
* @notice lorem ipsum
*/
function f() public { }
}
// ----
// ----
// :test userdoc
// {
// "methods": {}
// }

27
test/libsolidity/natspecJSON/struct_no_docs.sol Normal file
View File

@ -0,0 +1,27 @@
contract C {
/// @title example of title
/// @author example of author
/// @notice example of notice
/// @dev example of dev
struct Example {
string text;
bool valid;
uint256 value;
}
}
// ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

17
test/libsolidity/natspecJSON/user_basic_test.sol Normal file
View File

@ -0,0 +1,17 @@
contract test {
/// @notice Multiplies `a` by 7
function mul(uint a) public returns(uint d) { return a * 7; }
}
// ----
// ----
// :test userdoc
// {
// "methods":
// {
// "mul(uint256)":
// {
// "notice": "Multiplies `a` by 7"
// }
// }
// }

17
test/libsolidity/natspecJSON/user_constructor.sol Normal file
View File

@ -0,0 +1,17 @@
contract test {
/// @notice this is a really nice constructor
constructor(uint a, uint second) { }
}
// ----
// ----
// :test userdoc
// {
// "methods":
// {
// "constructor":
// {
// "notice": "this is a really nice constructor"
// }
// }
// }

23
test/libsolidity/natspecJSON/user_constructor_and_function.sol Normal file
View File

@ -0,0 +1,23 @@
contract test {
/// @notice this is a really nice constructor
constructor(uint a, uint second) { }
/// another multiplier
function mul(uint a, uint second) public returns(uint d) { return a * 7 + second; }
}
// ----
// ----
// :test userdoc
// {
// "methods":
// {
// "constructor":
// {
// "notice": "this is a really nice constructor"
// },
// "mul(uint256,uint256)":
// {
// "notice": "another multiplier"
// }
// }
// }

57
test/libsolidity/natspecJSON/user_default_inherit.sol Normal file
View File

@ -0,0 +1,57 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// Second line.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract Middle is ERC20 {
function transfer(address to, uint amount) virtual override external returns (bool)
{
return false;
}
}
contract Token is Middle {
function transfer(address to, uint amount) override external returns (bool)
{
return false;
}
}
// ----
// ----
// :ERC20 userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``. Second line."
// }
// }
// }
//
// :Middle userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``. Second line."
// }
// }
// }
//
// :Token userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``. Second line."
// }
// }
// }

35
test/libsolidity/natspecJSON/user_default_inherit_variable.sol Normal file
View File

@ -0,0 +1,35 @@
contract C {
/// @notice Hello world
/// @dev test
function x() virtual external returns (uint) {
return 1;
}
}
contract D is C {
uint public override x;
}
// ----
// ----
// :C userdoc
// {
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// }
// }
//
// :D userdoc
// {
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// }
// }

8
test/libsolidity/natspecJSON/user_empty_contract.sol Normal file
View File

@ -0,0 +1,8 @@
contract test { }
// ----
// ----
// :test userdoc
// {
// "methods": {}
// }

13
test/libsolidity/natspecJSON/user_empty_natspec_test.sol Normal file
View File

@ -0,0 +1,13 @@
contract test {
///
///
function f() public {
}
}
// ----
// ----
// :test userdoc
// {
// "methods": {}
// }

44
test/libsolidity/natspecJSON/user_explicit_inherit.sol Normal file
View File

@ -0,0 +1,44 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract ERC21 {
function transfer(address to, uint amount) virtual external returns (bool) {
return false;
}
}
contract Token is ERC21, ERC20 {
/// @inheritdoc ERC20
function transfer(address to, uint amount) override(ERC21, ERC20) external returns (bool) {
return false;
}
}
// ----
// ----
// :ERC20 userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// }
//
// :Token userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// }

55
test/libsolidity/natspecJSON/user_explicit_inherit2.sol Normal file
View File

@ -0,0 +1,55 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract ERC21 is ERC20 {
function transfer(address to, uint amount) virtual override external returns (bool) {
return false;
}
}
contract Token is ERC20 {
/// @inheritdoc ERC20
function transfer(address to, uint amount) override external returns (bool) {
return false;
}
}
// ----
// ----
// :ERC20 userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// }
//
// :ERC21 userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// }
//
// :Token userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// }

46
test/libsolidity/natspecJSON/user_explicit_inherit_partial.sol Normal file
View File

@ -0,0 +1,46 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract ERC21 {
function transfer(address to, uint amount) virtual external returns (bool) {
return false;
}
}
contract Token is ERC21, ERC20 {
/// @inheritdoc ERC20
/// @dev override dev comment
/// @notice override notice
function transfer(address to, uint amount) override(ERC21, ERC20) external returns (bool) {
return false;
}
}
// ----
// ----
// :ERC20 userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// }
//
// :Token userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "override notice"
// }
// }
// }

46
test/libsolidity/natspecJSON/user_explicit_inherit_partial2.sol Normal file
View File

@ -0,0 +1,46 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract ERC21 is ERC20 {
/// @inheritdoc ERC20
/// @dev override dev comment
/// @notice override notice
function transfer(address to, uint amount) virtual override external returns (bool) {
return false;
}
}
contract Token is ERC21 {
function transfer(address to, uint amount) override external returns (bool) {
return false;
}
}
// ----
// ----
// :ERC20 userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// }
//
// :Token userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "override notice"
// }
// }
// }

42
test/libsolidity/natspecJSON/user_explicit_inherit_variable.sol Normal file
View File

@ -0,0 +1,42 @@
contract B {
function x() virtual external returns (uint) {
return 1;
}
}
contract C {
/// @notice Hello world
/// @dev test
function x() virtual external returns (uint) {
return 1;
}
}
contract D is C, B {
/// @inheritdoc C
uint public override(C, B) x;
}
// ----
// ----
// :C userdoc
// {
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// }
// }
//
// :D userdoc
// {
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// }
// }

48
test/libsolidity/natspecJSON/user_inherit_parameter_mismatch.sol Normal file
View File

@ -0,0 +1,48 @@
interface ERC20 {
/// Transfer ``amount`` from ``msg.sender`` to ``to``.
/// @dev test
/// @param to address to transfer to
/// @param amount amount to transfer
function transfer(address to, uint amount) external returns (bool);
}
contract Middle is ERC20 {
function transfer(address to, uint amount) override virtual external returns (bool) {
return false;
}
}
contract Token is Middle {
function transfer(address too, uint amount) override external returns (bool) {
return false;
}
}
// ----
// ----
// :ERC20 userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// }
//
// :Middle userdoc
// {
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// }
//
// :Token userdoc
// {
// "methods": {}
// }

20
test/libsolidity/natspecJSON/user_multiline_comment.sol Normal file
View File

@ -0,0 +1,20 @@
contract test {
/// @notice Multiplies `a` by 7
/// and then adds `b`
function mul_and_add(uint a, uint256 b) public returns (uint256 d) {
return (a * 7) + b;
}
}
// ----
// ----
// :test userdoc
// {
// "methods":
// {
// "mul_and_add(uint256,uint256)":
// {
// "notice": "Multiplies `a` by 7 and then adds `b`"
// }
// }
// }

22
test/libsolidity/natspecJSON/user_multiline_empty_lines.sol Normal file
View File

@ -0,0 +1,22 @@
contract test {
/**
*
*
* @notice hello world
*/
function f() public {
}
}
// ----
// ----
// :test userdoc
// {
// "methods":
// {
// "f()":
// {
// "notice": "hello world"
// }
// }
// }

37
test/libsolidity/natspecJSON/user_multiple_functions.sol Normal file
View File

@ -0,0 +1,37 @@
contract test {
/// @notice Multiplies `a` by 7 and then adds `b`
function mul_and_add(uint a, uint256 b) public returns (uint256 d) {
return (a * 7) + b;
}
/// @notice Divides `input` by `div`
function divide(uint input, uint div) public returns (uint d) {
return input / div;
}
/// @notice Subtracts 3 from `input`
function sub(int input) public returns (int d) {
return input - 3;
}
}
// ----
// ----
// :test userdoc
// {
// "methods":
// {
// "divide(uint256,uint256)":
// {
// "notice": "Divides `input` by `div`"
// },
// "mul_and_add(uint256,uint256)":
// {
// "notice": "Multiplies `a` by 7 and then adds `b`"
// },
// "sub(int256)":
// {
// "notice": "Subtracts 3 from `input`"
// }
// }
// }

21
test/libsolidity/natspecJSON/user_newline_break.sol Normal file
View File

@ -0,0 +1,21 @@
contract test {
///
/// @notice hello
/// @notice world
function f() public {
}
}
// ----
// ----
// :test userdoc
// {
// "methods":
// {
// "f()":
// {
// "notice": "world"
// }
// }
// }