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

natspecJSON: Include version and kind fields in expectations where missing

Browse Source
This commit is contained in:
Kamil Śliwak 2023-08-09 19:33:35 +02:00
parent 99bfdf930a
commit 481c7256cb
71 changed files with 360 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -17,6 +17,7 @@ contract A {
// "custom:t": "onetwo",
// "custom:x": "one two three",
// "custom:y": "line break",
// "kind": "dev",
// "methods":
// {
// "g(int256)":
@ -30,5 +31,6 @@ contract A {
// {
// "custom:note": "statevar"
// }
// }
// },
// "version": 1
// }

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

@ -10,16 +10,20 @@ contract B is A {
// ----
// :A devdoc
// {
// "kind": "dev",
// "methods":
// {
// "g(uint256)":
// {
// "custom:since": "2014"
// }
// }
// },
// "version": 1
// }
//
// :B devdoc
// {
// "methods": {}
// "kind": "dev",
// "methods": {},
// "version": 1
// }

8
test/libsolidity/natspecJSON/dev_and_user_basic_test.sol
View File

@ -8,22 +8,26 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256)":
// {
// "details": "Multiplies a number by 7"
// }
// }
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "mul(uint256)":
// {
// "notice": "Multiplies `a` by 7"
// }
// }
// },
// "version": 1
// }

8
test/libsolidity/natspecJSON/dev_and_user_no_doc.sol
View File

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

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

@ -8,6 +8,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "constructor":
@ -18,5 +19,6 @@ contract test {
// "second": "the second parameter is not very useful, it just provides additional confusion"
// }
// }
// }
// },
// "version": 1
// }

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

@ -17,6 +17,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "constructor":
@ -40,5 +41,6 @@ contract test {
// "d": "The result of the multiplication and cookies with nutella"
// }
// }
// }
// },
// "version": 1
// }

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

@ -10,6 +10,7 @@ contract test {
// :test devdoc
// {
// "author": "Lefteris",
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -17,5 +18,6 @@ contract test {
// "details": "Mul function"
// }
// },
// "title": "Just a test contract"
// "title": "Just a test contract",
// "version": 1
// }

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

@ -7,11 +7,13 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
// {
// "details": "Mul function"
// }
// }
// },
// "version": 1
// }

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

@ -25,6 +25,7 @@ contract Token is Middle {
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -36,11 +37,13 @@ contract Token is Middle {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }
//
// :Middle devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -52,11 +55,13 @@ contract Token is Middle {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -68,5 +73,6 @@ contract Token is Middle {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }

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

@ -14,17 +14,20 @@ contract D is C {
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods":
// {
// "x()":
// {
// "details": "test"
// }
// }
// },
// "version": 1
// }
//
// :D devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
@ -32,5 +35,6 @@ contract D is C {
// {
// "details": "test"
// }
// }
// },
// "version": 1
// }

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

@ -10,6 +10,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -21,5 +22,6 @@ contract test {
// "second": "Documentation for the second parameter"
// }
// }
// }
// },
// "version": 1
// }

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

@ -11,6 +11,7 @@ contract B is A {
// ----
// :A devdoc
// {
// "kind": "dev",
// "methods":
// {
// "g(int256)":
@ -20,11 +21,13 @@ contract B is A {
// "y": "value"
// }
// }
// }
// },
// "version": 1
// }
//
// :B devdoc
// {
// "kind": "dev",
// "methods":
// {
// "g(int256)":
@ -34,5 +37,6 @@ contract B is A {
// "z": "value"
// }
// }
// }
// },
// "version": 1
// }

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

@ -12,6 +12,7 @@ contract B is A {
// ----
// :A devdoc
// {
// "kind": "dev",
// "methods":
// {
// "g(int256)":
@ -22,11 +23,13 @@ contract B is A {
// "b": "value B"
// }
// }
// }
// },
// "version": 1
// }
//
// :B devdoc
// {
// "kind": "dev",
// "methods":
// {
// "g(int256)":
@ -37,5 +40,6 @@ contract B is A {
// "z": "value A"
// }
// }
// }
// },
// "version": 1
// }

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

@ -12,6 +12,7 @@ contract B is A {
// ----
// :A devdoc
// {
// "kind": "dev",
// "methods":
// {
// "g(int256)":
@ -22,11 +23,13 @@ contract B is A {
// "b": "value B"
// }
// }
// }
// },
// "version": 1
// }
//
// :B devdoc
// {
// "kind": "dev",
// "methods":
// {
// "g(int256)":
@ -37,5 +40,6 @@ contract B is A {
// "z": "value A"
// }
// }
// }
// },
// "version": 1
// }

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

@ -12,6 +12,7 @@ contract B is A {
// ----
// :A devdoc
// {
// "kind": "dev",
// "methods":
// {
// "g(int256)":
@ -22,11 +23,13 @@ contract B is A {
// "_1": "value B"
// }
// }
// }
// },
// "version": 1
// }
//
// :B devdoc
// {
// "kind": "dev",
// "methods":
// {
// "g(int256)":
@ -37,5 +40,6 @@ contract B is A {
// "z": "value A"
// }
// }
// }
// },
// "version": 1
// }

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

@ -23,6 +23,7 @@ contract Token is ERC21, ERC20 {
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -34,11 +35,13 @@ contract Token is ERC21, ERC20 {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -50,5 +53,6 @@ contract Token is ERC21, ERC20 {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }

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

@ -23,6 +23,7 @@ contract Token is ERC20 {
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -34,11 +35,13 @@ contract Token is ERC20 {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }
//
// :ERC21 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -50,11 +53,13 @@ contract Token is ERC20 {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -66,5 +71,6 @@ contract Token is ERC20 {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }

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

@ -30,6 +30,7 @@ contract Token is myInterfaces.ERC20, myInterfaces.ERC21 {
// ----
// Testfile.sol:Token devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -41,5 +42,6 @@ contract Token is myInterfaces.ERC20, myInterfaces.ERC21 {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }

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

@ -25,6 +25,7 @@ contract Token is ERC21, ERC20 {
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -36,11 +37,13 @@ contract Token is ERC21, ERC20 {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -52,5 +55,6 @@ contract Token is ERC21, ERC20 {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }

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

@ -25,6 +25,7 @@ contract Token is ERC21 {
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -36,11 +37,13 @@ contract Token is ERC21 {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }
//
// :Token devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -52,5 +55,6 @@ contract Token is ERC21 {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }

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

@ -21,17 +21,20 @@ contract D is C, B {
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods":
// {
// "x()":
// {
// "details": "test"
// }
// }
// },
// "version": 1
// }
//
// :D devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
@ -39,5 +42,6 @@ contract D is C, B {
// {
// "details": "test"
// }
// }
// },
// "version": 1
// }

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

@ -22,6 +22,7 @@ contract Token is Middle {
// ----
// :ERC20 devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -33,11 +34,13 @@ contract Token is Middle {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }
//
// :Middle devdoc
// {
// "kind": "dev",
// "methods":
// {
// "transfer(address,uint256)":
@ -49,10 +52,13 @@ contract Token is Middle {
// "to": "address to transfer to"
// }
// }
// }
// },
// "version": 1
// }
//
// :Token devdoc
// {
// "methods": {}
// "kind": "dev",
// "methods": {},
// "version": 1
// }

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

@ -16,6 +16,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -31,5 +32,6 @@ contract test {
// "d": "The result of the multiplication and cookies with nutella"
// }
// }
// }
// },
// "version": 1
// }

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

@ -14,6 +14,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -29,5 +30,6 @@ contract test {
// "d": "The result of the multiplication and cookies with nutella"
// }
// }
// }
// },
// "version": 1
// }

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

@ -22,6 +22,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "divide(uint256,uint256)":
@ -50,5 +51,6 @@ contract test {
// "input": "Documentation for the input parameter"
// }
// }
// }
// },
// "version": 1
// }

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

@ -9,6 +9,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -20,5 +21,6 @@ contract test {
// "second": "Documentation for the second parameter"
// }
// }
// }
// },
// "version": 1
// }

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

@ -9,6 +9,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -20,5 +21,6 @@ contract test {
// "second": "Documentation for the second parameter"
// }
// }
// }
// },
// "version": 1
// }

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

@ -10,6 +10,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -21,5 +22,6 @@ contract test {
// "second": "Documentation for the second parameter"
// }
// }
// }
// },
// "version": 1
// }

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

@ -11,6 +11,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -26,5 +27,6 @@ contract test {
// "d": "The result of the multiplication"
// }
// }
// }
// },
// "version": 1
// }

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

@ -14,6 +14,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -29,5 +30,6 @@ contract test {
// "d": "The result of the multiplication"
// }
// }
// }
// },
// "version": 1
// }

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

@ -15,6 +15,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -31,5 +32,6 @@ contract test {
// "f": "And cookies with nutella"
// }
// }
// }
// },
// "version": 1
// }

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

@ -15,6 +15,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -31,5 +32,6 @@ contract test {
// "_1": "And cookies with nutella"
// }
// }
// }
// },
// "version": 1
// }

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

@ -15,6 +15,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -31,5 +32,6 @@ contract test {
// "_cookies": "And cookies with nutella"
// }
// }
// }
// },
// "version": 1
// }

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

@ -17,6 +17,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -34,5 +35,6 @@ contract test {
// "_milk": "And milk with nutella"
// }
// }
// }
// },
// "version": 1
// }

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

@ -11,6 +11,7 @@ contract B is A {
// ----
// :A devdoc
// {
// "kind": "dev",
// "methods":
// {
// "g(int256)":
@ -20,11 +21,13 @@ contract B is A {
// "a": "a"
// }
// }
// }
// },
// "version": 1
// }
//
// :B devdoc
// {
// "kind": "dev",
// "methods":
// {
// "g(int256)":
@ -34,5 +37,6 @@ contract B is A {
// "b": "a"
// }
// }
// }
// },
// "version": 1
// }

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

@ -7,6 +7,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods":
// {
// "mul(uint256,uint256)":
@ -16,5 +17,6 @@ contract test {
// "d": "The result of the multiplication"
// }
// }
// }
// },
// "version": 1
// }

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

@ -17,6 +17,7 @@ contract Thing is IThing {
// ----
// :IThing devdoc
// {
// "kind": "dev",
// "methods":
// {
// "value()":
@ -27,11 +28,13 @@ contract Thing is IThing {
// "y": "another number"
// }
// }
// }
// },
// "version": 1
// }
//
// :Thing devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
@ -43,5 +46,6 @@ contract Thing is IThing {
// "y": "another number"
// }
// }
// }
// },
// "version": 1
// }

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

@ -17,6 +17,7 @@ contract Thing is IThing {
// ----
// :IThing devdoc
// {
// "kind": "dev",
// "methods":
// {
// "value()":
@ -27,11 +28,13 @@ contract Thing is IThing {
// "y": "another number"
// }
// }
// }
// },
// "version": 1
// }
//
// :Thing devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
@ -43,5 +46,6 @@ contract Thing is IThing {
// "b": "another number"
// }
// }
// }
// },
// "version": 1
// }

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

@ -15,6 +15,7 @@ contract Thing is IThing {
// ----
// :IThing devdoc
// {
// "kind": "dev",
// "methods":
// {
// "value(uint256)":
@ -24,11 +25,13 @@ contract Thing is IThing {
// "_0": ""
// }
// }
// }
// },
// "version": 1
// }
//
// :Thing devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
@ -40,5 +43,6 @@ contract Thing is IThing {
// "x": ""
// }
// }
// }
// },
// "version": 1
// }

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

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

8
test/libsolidity/natspecJSON/error.sol
View File

@ -24,7 +24,9 @@ contract test {
// }
// ]
// },
// "methods": {}
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
@ -38,5 +40,7 @@ contract test {
// }
// ]
// },
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

@ -45,7 +45,9 @@ contract test {
// }
// ]
// },
// "methods": {}
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :test userdoc
@ -62,5 +64,7 @@ contract test {
// }
// ]
// },
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }

8
test/libsolidity/natspecJSON/event.sol
View File

@ -24,7 +24,9 @@ contract ERC20 {
// }
// }
// },
// "methods": {}
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :ERC20 userdoc
@ -36,5 +38,7 @@ contract ERC20 {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }

24
test/libsolidity/natspecJSON/event_inheritance.sol
View File

@ -28,7 +28,9 @@ contract B is A {
// }
// }
// },
// "methods": {}
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :A userdoc
@ -40,7 +42,9 @@ contract B is A {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :B devdoc
@ -58,7 +62,9 @@ contract B is A {
// }
// }
// },
// "methods": {}
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :B userdoc
@ -70,7 +76,9 @@ contract B is A {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :ERC20 devdoc
@ -88,7 +96,9 @@ contract B is A {
// }
// }
// },
// "methods": {}
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :ERC20 userdoc
@ -100,5 +110,7 @@ contract B is A {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }

24
test/libsolidity/natspecJSON/event_inheritance_interface.sol
View File

@ -28,7 +28,9 @@ contract B is A {
// }
// }
// },
// "methods": {}
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :A userdoc
@ -40,7 +42,9 @@ contract B is A {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :B devdoc
@ -58,7 +62,9 @@ contract B is A {
// }
// }
// },
// "methods": {}
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :B userdoc
@ -70,7 +76,9 @@ contract B is A {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :ERC20 devdoc
@ -88,7 +96,9 @@ contract B is A {
// }
// }
// },
// "methods": {}
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :ERC20 userdoc
@ -100,5 +110,7 @@ contract B is A {
// "notice": "This event is emitted when a transfer occurs."
// }
// },
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

@ -8,11 +8,13 @@ contract test {
// ----
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "mul(uint256)":
// {
// "notice": "I do something awesome which requires two lines to explain"
// }
// }
// },
// "version": 1
// }

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

@ -7,11 +7,13 @@ contract test {
// ----
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "mul(uint256)":
// {
// "notice": "I do something awesome"
// }
// }
// },
// "version": 1
// }

8
test/libsolidity/natspecJSON/private_state_variable.sol
View File

@ -7,6 +7,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
@ -14,10 +15,13 @@ contract test {
// {
// "details": "example of dev"
// }
// }
// },
// "version": 1
// }
//
// :test userdoc
// {
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }

8
test/libsolidity/natspecJSON/public_state_variable.sol
View File

@ -9,6 +9,7 @@ contract test {
// ----
// :test devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
@ -21,16 +22,19 @@ contract test {
// "_0": "returns state"
// }
// }
// }
// },
// "version": 1
// }
//
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "state()":
// {
// "notice": "example of notice"
// }
// }
// },
// "version": 1
// }

8
test/libsolidity/natspecJSON/public_state_variable_struct.sol
View File

@ -14,6 +14,7 @@ contract Bank {
// ----
// :Bank devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
@ -25,16 +26,19 @@ contract Bank {
// "reverseGraphicURL": "Back pic"
// }
// }
// }
// },
// "version": 1
// }
//
// :Bank userdoc
// {
// "kind": "user",
// "methods":
// {
// "coinStack(uint256)":
// {
// "notice": "Get the n-th coin I own"
// }
// }
// },
// "version": 1
// }

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

@ -8,11 +8,13 @@ contract test {
// ----
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "f()":
// {
// "notice": "lorem ipsum"
// }
// }
// },
// "version": 1
// }

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

@ -8,11 +8,13 @@ contract test {
// ----
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "f()":
// {
// "notice": "lorem"
// }
// }
// },
// "version": 1
// }

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

@ -7,5 +7,7 @@ contract test {
// ----
// :test userdoc
// {
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

@ -9,5 +9,7 @@ contract test {
// ----
// :test userdoc
// {
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

@ -7,11 +7,13 @@ contract test {
// ----
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "mul(uint256)":
// {
// "notice": "Multiplies `a` by 7"
// }
// }
// },
// "version": 1
// }

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

@ -7,11 +7,13 @@ contract test {
// ----
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "constructor":
// {
// "notice": "this is a really nice constructor"
// }
// }
// },
// "version": 1
// }

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

@ -9,6 +9,7 @@ contract test {
// ----
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "constructor":
@ -19,5 +20,6 @@ contract test {
// {
// "notice": "another multiplier"
// }
// }
// },
// "version": 1
// }

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

@ -25,33 +25,39 @@ contract Token is Middle {
// ----
// :ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``. Second line."
// }
// }
// },
// "version": 1
// }
//
// :Middle userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``. Second line."
// }
// }
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``. Second line."
// }
// }
// },
// "version": 1
// }

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

@ -14,22 +14,26 @@ contract D is C {
// ----
// :C userdoc
// {
// "kind": "user",
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// }
// },
// "version": 1
// }
//
// :D userdoc
// {
// "kind": "user",
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// }
// },
// "version": 1
// }

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

@ -4,5 +4,7 @@ contract test { }
// ----
// :test userdoc
// {
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

@ -9,5 +9,7 @@ contract test {
// ----
// :test userdoc
// {
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

@ -23,22 +23,26 @@ contract Token is ERC21, ERC20 {
// ----
// :ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// },
// "version": 1
// }

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

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

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

@ -25,22 +25,26 @@ contract Token is ERC21, ERC20 {
// ----
// :ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "override notice"
// }
// }
// },
// "version": 1
// }

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

@ -25,22 +25,26 @@ contract Token is ERC21 {
// ----
// :ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "override notice"
// }
// }
// },
// "version": 1
// }

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

@ -21,22 +21,26 @@ contract D is C, B {
// ----
// :C userdoc
// {
// "kind": "user",
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// }
// },
// "version": 1
// }
//
// :D userdoc
// {
// "kind": "user",
// "methods":
// {
// "x()":
// {
// "notice": "Hello world"
// }
// }
// },
// "version": 1
// }

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

@ -22,27 +22,33 @@ contract Token is Middle {
// ----
// :ERC20 userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// },
// "version": 1
// }
//
// :Middle userdoc
// {
// "kind": "user",
// "methods":
// {
// "transfer(address,uint256)":
// {
// "notice": "Transfer ``amount`` from ``msg.sender`` to ``to``."
// }
// }
// },
// "version": 1
// }
//
// :Token userdoc
// {
// "methods": {}
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

@ -10,11 +10,13 @@ contract test {
// ----
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "mul_and_add(uint256,uint256)":
// {
// "notice": "Multiplies `a` by 7 and then adds `b`"
// }
// }
// },
// "version": 1
// }

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

@ -12,11 +12,13 @@ contract test {
// ----
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "f()":
// {
// "notice": "hello world"
// }
// }
// },
// "version": 1
// }

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

@ -19,6 +19,7 @@ contract test {
// ----
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "divide(uint256,uint256)":
@ -33,5 +34,6 @@ contract test {
// {
// "notice": "Subtracts 3 from `input`"
// }
// }
// },
// "version": 1
// }

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

@ -11,11 +11,13 @@ contract test {
// ----
// :test userdoc
// {
// "kind": "user",
// "methods":
// {
// "f()":
// {
// "notice": "world"
// }
// }
// },
// "version": 1
// }