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

natspecJSON: Generate missing expectations (including errors)

Browse Source
This commit is contained in:
Kamil Śliwak 2023-08-21 12:32:33 +02:00
parent 481c7256cb
commit d083925bed
79 changed files with 1531 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
test/libsolidity/natspecJSON/custom.sol
View File

@ -34,3 +34,10 @@ contract A {
// },
// "version": 1
// }
//
// :A userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

14
test/libsolidity/natspecJSON/custom_inheritance.sol
View File

@ -21,9 +21,23 @@ contract B is A {
// "version": 1
// }
//
// :A userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :B devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :B userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

1
test/libsolidity/natspecJSON/dev_author_at_function.sol
View File

@ -7,3 +7,4 @@ contract test {
}
// ----
// DocstringParsingError 6546: (73-119): Documentation tag @author not valid for functions.

7
test/libsolidity/natspecJSON/dev_constructor.sol
View File

@ -22,3 +22,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_constructor_and_function.sol
View File

@ -44,3 +44,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

2
test/libsolidity/natspecJSON/dev_constructor_return.sol
View File

@ -6,3 +6,5 @@ contract test {
}
// ----
// DocstringParsingError 6546: (20-239): Documentation tag @return not valid for constructor.
// DocstringParsingError 2604: (20-239): Documentation tag "@return return should not work within constructors" exceeds the number of return parameters.

7
test/libsolidity/natspecJSON/dev_contract_doc.sol
View File

@ -21,3 +21,10 @@ contract test {
// "title": "Just a test contract",
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_contract_no_doc.sol
View File

@ -17,3 +17,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

39
test/libsolidity/natspecJSON/dev_default_inherit.sol
View File

@ -41,6 +41,19 @@ contract Token is Middle {
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``. Second line."
// }
// },
// "version": 1
// }
//
// :Middle devdoc
// {
// "kind": "dev",
@ -59,6 +72,19 @@ contract Token is Middle {
// "version": 1
// }
//
// :Middle userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``. Second line."
// }
// },
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
@ -76,3 +102,16 @@ contract Token is Middle {
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``. Second line."
// }
// },
// "version": 1
// }

26
test/libsolidity/natspecJSON/dev_default_inherit_variable.sol
View File

@ -25,6 +25,19 @@ contract D is C {
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// },
// "version": 1
// }
//
// :D devdoc
// {
// "kind": "dev",
@ -38,3 +51,16 @@ contract D is C {
// },
// "version": 1
// }
//
// :D userdoc
// {
// "kind": "user",
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// },
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_desc_after_nl.sol
View File

@ -25,3 +25,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

14
test/libsolidity/natspecJSON/dev_different_return_name.sol
View File

@ -25,6 +25,13 @@ contract B is A {
// "version": 1
// }
//
// :A userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :B devdoc
// {
// "kind": "dev",
@ -40,3 +47,10 @@ contract B is A {
// },
// "version": 1
// }
//
// :B userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

14
test/libsolidity/natspecJSON/dev_different_return_name_multiple.sol
View File

@ -27,6 +27,13 @@ contract B is A {
// "version": 1
// }
//
// :A userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :B devdoc
// {
// "kind": "dev",
@ -43,3 +50,10 @@ contract B is A {
// },
// "version": 1
// }
//
// :B userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

14
test/libsolidity/natspecJSON/dev_different_return_name_multiple_partly_unnamed.sol
View File

@ -27,6 +27,13 @@ contract B is A {
// "version": 1
// }
//
// :A userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :B devdoc
// {
// "kind": "dev",
@ -43,3 +50,10 @@ contract B is A {
// },
// "version": 1
// }
//
// :B userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

14
test/libsolidity/natspecJSON/dev_different_return_name_multiple_unnamed.sol
View File

@ -27,6 +27,13 @@ contract B is A {
// "version": 1
// }
//
// :A userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :B devdoc
// {
// "kind": "dev",
@ -43,3 +50,10 @@ contract B is A {
// },
// "version": 1
// }
//
// :B userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

1
test/libsolidity/natspecJSON/dev_documenting_no_param_description.sol
View File

@ -6,3 +6,4 @@ contract test {
}
// ----
// DocstringParsingError 9942: (20-156): No description given for param second

1
test/libsolidity/natspecJSON/dev_documenting_no_param_name.sol
View File

@ -6,3 +6,4 @@ contract test {
}
// ----
// DocstringParsingError 3335: (20-149): No param name given

1
test/libsolidity/natspecJSON/dev_documenting_no_param_name_end.sol
View File

@ -6,3 +6,4 @@ contract test {
}
// ----
// DocstringParsingError 9942: (20-152): No description given for param se

1
test/libsolidity/natspecJSON/dev_documenting_no_return_param_name.sol
View File

@ -7,3 +7,4 @@ contract test {
}
// ----
// DocstringParsingError 5856: (20-211): Documentation tag "@return " does not contain the name of its return parameter.

1
test/libsolidity/natspecJSON/dev_documenting_nonexistent_param.sol
View File

@ -6,3 +6,4 @@ contract test {
}
// ----
// DocstringParsingError 3881: (20-201): Documented parameter "not_existing" not found in the parameter list of the function.

40
test/libsolidity/natspecJSON/dev_explicit_inherit.sol
View File

@ -39,6 +39,33 @@ contract Token is ERC21, ERC20 {
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }
//
// :ERC21 devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :ERC21 userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
@ -56,3 +83,16 @@ contract Token is ERC21, ERC20 {
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }

39
test/libsolidity/natspecJSON/dev_explicit_inherit2.sol
View File

@ -39,6 +39,19 @@ contract Token is ERC20 {
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }
//
// :ERC21 devdoc
// {
// "kind": "dev",
@ -57,6 +70,19 @@ contract Token is ERC20 {
// "version": 1
// }
//
// :ERC21 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
@ -74,3 +100,16 @@ contract Token is ERC20 {
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }

75
test/libsolidity/natspecJSON/dev_explicit_inherit_complex.sol
View File

@ -28,6 +28,68 @@ contract Token is myInterfaces.ERC20, myInterfaces.ERC21 {
// ----
// ----
// Interfaces.sol:ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// Interfaces.sol:ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }
//
// Interfaces.sol:ERC21 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test2",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// Interfaces.sol:ERC21 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }
//
// Testfile.sol:Token devdoc
// {
// "kind": "dev",
@ -45,3 +107,16 @@ contract Token is myInterfaces.ERC20, myInterfaces.ERC21 {
// },
// "version": 1
// }
//
// Testfile.sol:Token userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }

40
test/libsolidity/natspecJSON/dev_explicit_inherit_partial.sol
View File

@ -41,6 +41,33 @@ contract Token is ERC21, ERC20 {
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }
//
// :ERC21 devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :ERC21 userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
@ -58,3 +85,16 @@ contract Token is ERC21, ERC20 {
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "override notice"
// }
// },
// "version": 1
// }

57
test/libsolidity/natspecJSON/dev_explicit_inherit_partial2.sol
View File

@ -41,6 +41,50 @@ contract Token is ERC21 {
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }
//
// :ERC21 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "override dev comment",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :ERC21 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "override notice"
// }
// },
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
@ -58,3 +102,16 @@ contract Token is ERC21 {
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "override notice"
// }
// },
// "version": 1
// }

40
test/libsolidity/natspecJSON/dev_explicit_inherit_variable.sol
View File

@ -19,6 +19,20 @@ contract D is C, B {
// ----
// ----
// :B devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :B userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :C devdoc
// {
// "kind": "dev",
@ -32,6 +46,19 @@ contract D is C, B {
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// },
// "version": 1
// }
//
// :D devdoc
// {
// "kind": "dev",
@ -45,3 +72,16 @@ contract D is C, B {
// },
// "version": 1
// }
//
// :D userdoc
// {
// "kind": "user",
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// },
// "version": 1
// }

33
test/libsolidity/natspecJSON/dev_inherit_parameter_mismatch.sol
View File

@ -38,6 +38,19 @@ contract Token is Middle {
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }
//
// :Middle devdoc
// {
// "kind": "dev",
@ -56,9 +69,29 @@ contract Token is Middle {
// "version": 1
// }
//
// :Middle userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// },
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_multiline_comment.sol
View File

@ -35,3 +35,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_multiline_return.sol
View File

@ -33,3 +33,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_multiple_functions.sol
View File

@ -54,3 +54,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_multiple_params.sol
View File

@ -24,3 +24,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_multiple_params_mixed_whitespace.sol
View File

@ -24,3 +24,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_mutiline_param_description.sol
View File

@ -25,3 +25,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_return.sol
View File

@ -30,3 +30,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_return_desc_after_nl.sol
View File

@ -33,3 +33,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_return_desc_multiple.sol
View File

@ -35,3 +35,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_return_desc_multiple_unamed.sol
View File

@ -35,3 +35,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_return_desc_multiple_unamed_mixed.sol
View File

@ -35,3 +35,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_return_desc_multiple_unamed_mixed_2.sol
View File

@ -38,3 +38,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

14
test/libsolidity/natspecJSON/dev_return_name_no_description.sol
View File

@ -25,6 +25,13 @@ contract B is A {
// "version": 1
// }
//
// :A userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :B devdoc
// {
// "kind": "dev",
@ -40,3 +47,10 @@ contract B is A {
// },
// "version": 1
// }
//
// :B userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/dev_return_no_params.sol
View File

@ -20,3 +20,10 @@ contract test {
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

14
test/libsolidity/natspecJSON/dev_struct_getter_override.sol
View File

@ -32,6 +32,13 @@ contract Thing is IThing {
// "version": 1
// }
//
// :IThing userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :Thing devdoc
// {
// "kind": "dev",
@ -49,3 +56,10 @@ contract Thing is IThing {
// },
// "version": 1
// }
//
// :Thing userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

14
test/libsolidity/natspecJSON/dev_struct_getter_override_different_return_parameter_names.sol
View File

@ -32,6 +32,13 @@ contract Thing is IThing {
// "version": 1
// }
//
// :IThing userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :Thing devdoc
// {
// "kind": "dev",
@ -49,3 +56,10 @@ contract Thing is IThing {
// },
// "version": 1
// }
//
// :Thing userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

14
test/libsolidity/natspecJSON/dev_struct_getter_override_no_return_name.sol
View File

@ -29,6 +29,13 @@ contract Thing is IThing {
// "version": 1
// }
//
// :IThing userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :Thing devdoc
// {
// "kind": "dev",
@ -46,3 +53,10 @@ contract Thing is IThing {
// },
// "version": 1
// }
//
// :Thing userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

1
test/libsolidity/natspecJSON/dev_title_at_function_error.sol
View File

@ -7,3 +7,4 @@ contract test {
}
// ----
// DocstringParsingError 6546: (73-137): Documentation tag @title not valid for functions.

28
test/libsolidity/natspecJSON/emit_event_from_foreign_contract.sol
View File

@ -39,3 +39,31 @@ contract C {
// "methods": {},
// "version": 1
// }
//
// :X devdoc
// {
// "events":
// {
// "E()":
// {
// "details": "Devdoc for event E."
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :X userdoc
// {
// "events":
// {
// "E()":
// {
// "notice": "Userdoc for event E."
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

28
test/libsolidity/natspecJSON/emit_event_from_foreign_contract_no_inheritance.sol
View File

@ -16,6 +16,34 @@ contract D {
// ----
// ----
// :C devdoc
// {
// "events":
// {
// "E()":
// {
// "details": "C.E event"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "events":
// {
// "E()":
// {
// "notice": "C.E event"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :D devdoc
// {
// "kind": "dev",

56
test/libsolidity/natspecJSON/emit_same_signature_event_different_libraries.sol
View File

@ -64,3 +64,59 @@ contract C {
// "methods": {},
// "version": 1
// }
//
// :L2 devdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "details": "This should not appear in Contract C dev doc"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :L2 userdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "notice": "This event is defined in Library L2"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :L3 devdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "details": "This should not appear in Contract C dev doc"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :L3 userdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "notice": "This event is defined in Library L3"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

56
test/libsolidity/natspecJSON/emit_same_signature_event_different_libraries_missing_natspec.sol
View File

@ -32,3 +32,59 @@ contract C {
// "methods": {},
// "version": 1
// }
//
// :L1 devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :L1 userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :L2 devdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "details": "This should not appear in Contract C devdoc"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :L2 userdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "notice": "This event is defined in library L2"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :L3 devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :L3 userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

36
test/libsolidity/natspecJSON/emit_same_signature_event_library_contract.sol
View File

@ -66,3 +66,39 @@ contract C {
// "methods": {},
// "version": 1
// }
//
// :L devdoc
// {
// "events":
// {
// "LibraryEvent(uint32)":
// {
// "details": "This should appear in Contract C dev doc"
// },
// "SameSignatureEvent(uint16)":
// {
// "details": "This should not appear in Contract C dev doc"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :L userdoc
// {
// "events":
// {
// "LibraryEvent(uint32)":
// {
// "notice": "This event is defined in Library L"
// },
// "SameSignatureEvent(uint16)":
// {
// "notice": "This event is defined in Library L"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

36
test/libsolidity/natspecJSON/emit_same_signature_event_library_contract_missing_natspec.sol
View File

@ -51,3 +51,39 @@ contract C {
// "methods": {},
// "version": 1
// }
//
// :L devdoc
// {
// "events":
// {
// "LibraryEvent(uint32)":
// {
// "details": "This should appear in contract C devdoc"
// },
// "SameSignatureEvent(uint16)":
// {
// "details": "This should not appear in contract C devdoc"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :L userdoc
// {
// "events":
// {
// "LibraryEvent(uint32)":
// {
// "notice": "This event is defined in library L"
// },
// "SameSignatureEvent(uint16)":
// {
// "notice": "This event is defined in library L"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

56
test/libsolidity/natspecJSON/emit_same_signature_event_library_inherited.sol
View File

@ -44,3 +44,59 @@ contract C is D {
// "methods": {},
// "version": 1
// }
//
// :D devdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "details": "This should appear in Contract C dev doc"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :D userdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "notice": "This event is defined in contract D"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :L devdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "details": "This should not appear in Contract C"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :L userdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "notice": "This event is defined in Library L"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

42
test/libsolidity/natspecJSON/emit_same_signature_event_library_inherited_missing_natspec.sol
View File

@ -28,3 +28,45 @@ contract C is D {
// "methods": {},
// "version": 1
// }
//
// :D devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :D userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :L devdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "details": "This should not appear in contract C devdoc"
// }
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :L userdoc
// {
// "events":
// {
// "SameSignatureEvent(uint16)":
// {
// "notice": "This event is defined in library L"
// }
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }

7
test/libsolidity/natspecJSON/empty_comment.sol
View File

@ -4,6 +4,13 @@ contract test
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

37
test/libsolidity/natspecJSON/error_multiple.sol
View File

@ -21,6 +21,43 @@ contract test {
// ----
// ----
// :A devdoc
// {
// "errors":
// {
// "E(uint256,uint256)":
// [
// {
// "details": "an error.",
// "params":
// {
// "x": "first parameter",
// "y": "second parameter"
// }
// }
// ]
// },
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :A userdoc
// {
// "errors":
// {
// "E(uint256,uint256)":
// [
// {
// "notice": "Something failed."
// }
// ]
// },
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :test devdoc
// {
// "errors":

7
test/libsolidity/natspecJSON/multiline_notice_without_tag.sol
View File

@ -6,6 +6,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/notice_without_tag.sol
View File

@ -5,6 +5,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

1
test/libsolidity/natspecJSON/public_state_variable_struct_repeated.sol
View File

@ -11,3 +11,4 @@ contract Bank {
}
// ----
// DocstringParsingError 5856: (113-236): Documentation tag "@return obverseGraphicURL Front pic" does not contain the name of its return parameter.

7
test/libsolidity/natspecJSON/slash3_slash3.sol
View File

@ -6,6 +6,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/slash3_slash4.sol
View File

@ -6,6 +6,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/slash4.sol
View File

@ -5,6 +5,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/star3.sol
View File

@ -7,6 +7,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/user_basic_test.sol
View File

@ -5,6 +5,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/user_constructor.sol
View File

@ -5,6 +5,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/user_constructor_and_function.sol
View File

@ -7,6 +7,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

54
test/libsolidity/natspecJSON/user_default_inherit.sol
View File

@ -23,6 +23,24 @@ contract Token is Middle {
// ----
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
@ -36,6 +54,24 @@ contract Token is Middle {
// "version": 1
// }
//
// :Middle devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :Middle userdoc
// {
// "kind": "user",
@ -49,6 +85,24 @@ contract Token is Middle {
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",

27
test/libsolidity/natspecJSON/user_default_inherit_variable.sol
View File

@ -12,6 +12,19 @@ contract D is C {
// ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods":
// {
// "x()":
// {
// "details": "test"
// }
// },
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
@ -25,6 +38,20 @@ contract D is C {
// "version": 1
// }
//
// :D devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
// "x":
// {
// "details": "test"
// }
// },
// "version": 1
// }
//
// :D userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/user_empty_contract.sol
View File

@ -2,6 +2,13 @@ contract test { }
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/user_empty_natspec_test.sol
View File

@ -7,6 +7,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

50
test/libsolidity/natspecJSON/user_explicit_inherit.sol
View File

@ -21,6 +21,24 @@ contract Token is ERC21, ERC20 {
// ----
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
@ -34,6 +52,38 @@ contract Token is ERC21, ERC20 {
// "version": 1
// }
//
// :ERC21 devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :ERC21 userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",

54
test/libsolidity/natspecJSON/user_explicit_inherit2.sol
View File

@ -21,6 +21,24 @@ contract Token is ERC20 {
// ----
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
@ -34,6 +52,24 @@ contract Token is ERC20 {
// "version": 1
// }
//
// :ERC21 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :ERC21 userdoc
// {
// "kind": "user",
@ -47,6 +83,24 @@ contract Token is ERC20 {
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",

50
test/libsolidity/natspecJSON/user_explicit_inherit_partial.sol
View File

@ -23,6 +23,24 @@ contract Token is ERC21, ERC20 {
// ----
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
@ -36,6 +54,38 @@ contract Token is ERC21, ERC20 {
// "version": 1
// }
//
// :ERC21 devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :ERC21 userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "override dev comment",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",

67
test/libsolidity/natspecJSON/user_explicit_inherit_partial2.sol
View File

@ -23,6 +23,24 @@ contract Token is ERC21 {
// ----
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
@ -36,6 +54,55 @@ contract Token is ERC21 {
// "version": 1
// }
//
// :ERC21 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "override dev comment",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :ERC21 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "override notice"
// }
// },
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "override dev comment",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",

41
test/libsolidity/natspecJSON/user_explicit_inherit_variable.sol
View File

@ -19,6 +19,33 @@ contract D is C, B {
// ----
// ----
// :B devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :B userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :C devdoc
// {
// "kind": "dev",
// "methods":
// {
// "x()":
// {
// "details": "test"
// }
// },
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
@ -32,6 +59,20 @@ contract D is C, B {
// "version": 1
// }
//
// :D devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
// "x":
// {
// "details": "test"
// }
// },
// "version": 1
// }
//
// :D userdoc
// {
// "kind": "user",

43
test/libsolidity/natspecJSON/user_inherit_parameter_mismatch.sol
View File

@ -20,6 +20,24 @@ contract Token is Middle {
// ----
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :ERC20 userdoc
// {
// "kind": "user",
@ -33,6 +51,24 @@ contract Token is Middle {
// "version": 1
// }
//
// :Middle devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "details": "test",
// "params":
// {
// "amount": "amount to transfer",
// "to": "address to transfer to"
// }
// }
// },
// "version": 1
// }
//
// :Middle userdoc
// {
// "kind": "user",
@ -46,6 +82,13 @@ contract Token is Middle {
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/user_multiline_comment.sol
View File

@ -8,6 +8,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/user_multiline_empty_lines.sol
View File

@ -10,6 +10,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/user_multiple_functions.sol
View File

@ -17,6 +17,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",

7
test/libsolidity/natspecJSON/user_newline_break.sol
View File

@ -9,6 +9,13 @@ contract test {
// ----
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",