Skip to content

Commit b63a940

Browse files
cameelcameel
committed
Generate expectations for moved Natspec syntax tests
1 parent dc68480 commit b63a940

10 files changed

+248
-0
lines changed

‎test/libsolidity/natspecJSON/docstring_double_empty.sol

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,17 @@ contract C {
55
}
66
}
77
// ----
8+
// ----
9+
// :C devdoc
10+
// {
11+
// "kind": "dev",
12+
// "methods": {},
13+
// "version": 1
14+
// }
15+
//
16+
// :C userdoc
17+
// {
18+
// "kind": "user",
19+
// "methods": {},
20+
// "version": 1
21+
// }

‎test/libsolidity/natspecJSON/docstring_enum.sol

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,17 @@ contract C {
99
}
1010
}
1111
// ----
12+
// ----
13+
// :C devdoc
14+
// {
15+
// "kind": "dev",
16+
// "methods": {},
17+
// "version": 1
18+
// }
19+
//
20+
// :C userdoc
21+
// {
22+
// "kind": "user",
23+
// "methods": {},
24+
// "version": 1
25+
// }

‎test/libsolidity/natspecJSON/docstring_named_return_parameter.sol

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,26 @@ abstract contract C {
33
function vote() public virtual returns (uint value);
44
}
55
// ----
6+
// ----
7+
// :C devdoc
8+
// {
9+
// "kind": "dev",
10+
// "methods":
11+
// {
12+
// "vote()":
13+
// {
14+
// "returns":
15+
// {
16+
// "value": "The value returned by this function."
17+
// }
18+
// }
19+
// },
20+
// "version": 1
21+
// }
22+
//
23+
// :C userdoc
24+
// {
25+
// "kind": "user",
26+
// "methods": {},
27+
// "version": 1
28+
// }

‎test/libsolidity/natspecJSON/docstring_parameter.sol

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,17 @@ contract C {
1010
}
1111
}
1212
// ----
13+
// ----
14+
// :C devdoc
15+
// {
16+
// "kind": "dev",
17+
// "methods": {},
18+
// "version": 1
19+
// }
20+
//
21+
// :C userdoc
22+
// {
23+
// "kind": "user",
24+
// "methods": {},
25+
// "version": 1
26+
// }

‎test/libsolidity/natspecJSON/docstring_private_state_variable.sol

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,24 @@ contract C {
44
uint private state;
55
}
66
// ----
7+
// ----
8+
// :C devdoc
9+
// {
10+
// "kind": "dev",
11+
// "methods": {},
12+
// "stateVariables":
13+
// {
14+
// "state":
15+
// {
16+
// "details": "example of dev"
17+
// }
18+
// },
19+
// "version": 1
20+
// }
21+
//
22+
// :C userdoc
23+
// {
24+
// "kind": "user",
25+
// "methods": {},
26+
// "version": 1
27+
// }

‎test/libsolidity/natspecJSON/docstring_state_variable.sol

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,30 @@ contract C {
44
uint public state;
55
}
66
// ----
7+
// ----
8+
// :C devdoc
9+
// {
10+
// "kind": "dev",
11+
// "methods": {},
12+
// "stateVariables":
13+
// {
14+
// "state":
15+
// {
16+
// "details": "example of dev"
17+
// }
18+
// },
19+
// "version": 1
20+
// }
21+
//
22+
// :C userdoc
23+
// {
24+
// "kind": "user",
25+
// "methods":
26+
// {
27+
// "state()":
28+
// {
29+
// "notice": "example of notice"
30+
// }
31+
// },
32+
// "version": 1
33+
// }

‎test/libsolidity/natspecJSON/docstring_struct.sol

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,17 @@ contract C {
1010
}
1111
}
1212
// ----
13+
// ----
14+
// :C devdoc
15+
// {
16+
// "kind": "dev",
17+
// "methods": {},
18+
// "version": 1
19+
// }
20+
//
21+
// :C userdoc
22+
// {
23+
// "kind": "user",
24+
// "methods": {},
25+
// "version": 1
26+
// }

‎test/libsolidity/natspecJSON/docstring_variable.sol

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,17 @@ contract C {
1111
}
1212
}
1313
// ----
14+
// ----
15+
// :C devdoc
16+
// {
17+
// "kind": "dev",
18+
// "methods": {},
19+
// "version": 1
20+
// }
21+
//
22+
// :C userdoc
23+
// {
24+
// "kind": "user",
25+
// "methods": {},
26+
// "version": 1
27+
// }

‎test/libsolidity/natspecJSON/return_param_amount_differs.sol

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,53 @@ contract Thing is IThing {
1212

1313
Value public override value;
1414
}
15+
// ----
16+
// ----
17+
// :IThing devdoc
18+
// {
19+
// "kind": "dev",
20+
// "methods":
21+
// {
22+
// "value()":
23+
// {
24+
// "returns":
25+
// {
26+
// "x": "a number",
27+
// "y": "another number"
28+
// }
29+
// }
30+
// },
31+
// "version": 1
32+
// }
33+
//
34+
// :IThing userdoc
35+
// {
36+
// "kind": "user",
37+
// "methods": {},
38+
// "version": 1
39+
// }
40+
//
41+
// :Thing devdoc
42+
// {
43+
// "kind": "dev",
44+
// "methods": {},
45+
// "stateVariables":
46+
// {
47+
// "value":
48+
// {
49+
// "returns":
50+
// {
51+
// "x": "a number",
52+
// "y": "another number"
53+
// }
54+
// }
55+
// },
56+
// "version": 1
57+
// }
58+
//
59+
// :Thing userdoc
60+
// {
61+
// "kind": "user",
62+
// "methods": {},
63+
// "version": 1
64+
// }

‎test/libsolidity/natspecJSON/return_param_amount_differs2.sol

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,60 @@ contract Thing is IThing {
1414
mapping(uint256=>Value) public override value;
1515
}
1616
// ----
17+
// ----
18+
// :IThing devdoc
19+
// {
20+
// "kind": "dev",
21+
// "methods":
22+
// {
23+
// "value(uint256)":
24+
// {
25+
// "params":
26+
// {
27+
// "v": "value to search for"
28+
// },
29+
// "returns":
30+
// {
31+
// "x": "a number",
32+
// "y": "another number"
33+
// }
34+
// }
35+
// },
36+
// "version": 1
37+
// }
38+
//
39+
// :IThing userdoc
40+
// {
41+
// "kind": "user",
42+
// "methods": {},
43+
// "version": 1
44+
// }
45+
//
46+
// :Thing devdoc
47+
// {
48+
// "kind": "dev",
49+
// "methods": {},
50+
// "stateVariables":
51+
// {
52+
// "value":
53+
// {
54+
// "params":
55+
// {
56+
// "v": "value to search for"
57+
// },
58+
// "returns":
59+
// {
60+
// "x": "a number",
61+
// "y": "another number"
62+
// }
63+
// }
64+
// },
65+
// "version": 1
66+
// }
67+
//
68+
// :Thing userdoc
69+
// {
70+
// "kind": "user",
71+
// "methods": {},
72+
// "version": 1
73+
// }

0 commit comments

Comments
 (0)