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

Generate expectations for moved Natspec syntax tests

Browse Source
This commit is contained in:
Kamil Śliwak 2023-08-21 11:29:36 +02:00
parent dc68480f72
commit b63a94031f
10 changed files with 248 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -5,3 +5,17 @@ contract C {
} }
} }
// ---- // ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

@ -9,3 +9,17 @@ contract C {
} }
} }
// ---- // ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

23
test/libsolidity/natspecJSON/docstring_named_return_parameter.sol
View File

@ -3,3 +3,26 @@ abstract contract C {
function vote() public virtual returns (uint value); function vote() public virtual returns (uint value);
} }
// ---- // ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods":
// {
// "vote()":
// {
// "returns":
// {
// "value": "The value returned by this function."
// }
// }
// },
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

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

21
test/libsolidity/natspecJSON/docstring_private_state_variable.sol
View File

@ -4,3 +4,24 @@ contract C {
uint private state; uint private state;
} }
// ---- // ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
// "state":
// {
// "details": "example of dev"
// }
// },
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

@ -4,3 +4,30 @@ contract C {
uint public state; uint public state;
} }
// ---- // ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
// "state":
// {
// "details": "example of dev"
// }
// },
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods":
// {
// "state()":
// {
// "notice": "example of notice"
// }
// },
// "version": 1
// }

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

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

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

@ -11,3 +11,17 @@ contract C {
} }
} }
// ---- // ----
// ----
// :C devdoc
// {
// "kind": "dev",
// "methods": {},
// "version": 1
// }
//
// :C userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

@ -12,3 +12,53 @@ contract Thing is IThing {
Value public override value; Value public override value;
} }
// ----
// ----
// :IThing devdoc
// {
// "kind": "dev",
// "methods":
// {
// "value()":
// {
// "returns":
// {
// "x": "a number",
// "y": "another number"
// }
// }
// },
// "version": 1
// }
//
// :IThing userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :Thing devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
// "value":
// {
// "returns":
// {
// "x": "a number",
// "y": "another number"
// }
// }
// },
// "version": 1
// }
//
// :Thing userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }

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

@ -14,3 +14,60 @@ contract Thing is IThing {
mapping(uint256=>Value) public override value; mapping(uint256=>Value) public override value;
} }
// ---- // ----
// ----
// :IThing devdoc
// {
// "kind": "dev",
// "methods":
// {
// "value(uint256)":
// {
// "params":
// {
// "v": "value to search for"
// },
// "returns":
// {
// "x": "a number",
// "y": "another number"
// }
// }
// },
// "version": 1
// }
//
// :IThing userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }
//
// :Thing devdoc
// {
// "kind": "dev",
// "methods": {},
// "stateVariables":
// {
// "value":
// {
// "params":
// {
// "v": "value to search for"
// },
// "returns":
// {
// "x": "a number",
// "y": "another number"
// }
// }
// },
// "version": 1
// }
//
// :Thing userdoc
// {
// "kind": "user",
// "methods": {},
// "version": 1
// }